PyQED
PyQED is open-source research software for light–matter interactions, quantum dynamics, spectroscopy, open quantum systems, and electronic-structure workflows. The project combines reusable Python APIs with executable research examples and validation paths.
Project website: https://pyqed.org/
Documentation: https://docs.pyqed.org/
Issue tracker: https://github.com/binggu56/pyqed/issues
Project status
PyQED is active research software. Interfaces and numerical workflows have different maturity levels, and some are experimental. Consult the capability status before selecting a method for production work. A passing example or benchmark is evidence for the documented case, not a guarantee for every model or parameter regime.
Installation
Install a published release from PyPI:
python -m pip install pyqed
For the current bg development branch:
git clone --branch bg https://github.com/binggu56/pyqed.git
cd pyqed
python -m pip install -e .
Published releases provide platform wheels containing the production qchem accelerators. Source installs build the same required accelerators by default and therefore need a supported C/C++ toolchain. Verify an installation with:
python -m pyqed.qchem.check_install
The slow pure-Python integral implementation is an explicit reference/debug mode; see the installation guide for its source-build and runtime settings.
Use documentation from the same release or commit as the installed code. See the installation guide for verification and optional-dependency guidance.
Five-minute calculation
This native, small-basis RHF calculation does not require PySCF:
from pyqed.qchem import Molecule
mol = Molecule(
atom="H 0 0 0; H 0 0 0.74",
unit="angstrom",
basis="sto-3g",
)
mol.build(eri="auto")
mf = mol.RHF().run()
print("converged:", mf.converged)
print("RHF energy:", mf.e_tot)
Continue with the quickstart and the examples gallery.
Lattice-gauge pilot
pyqed.lgt contains a one-dimensional Schwinger-model pilot with compact quantum links and Wilson-line-dressed Fourier-DVR hopping. The alternating matter/link MPS represents every local Gauss law as a component of one additive vector quantum number, so the symmetric DMRG calculation needs no finite penalty. Reproduce the ED/MPS comparison and scaling figures with:
PYTHONPATH=. python examples/lgt/alternating_wilson_dvr_mps.py
The channel-targeted real-time calculation extracts M_V and M_S without a multiroot state-averaged sweep:
PYTHONPATH=. python examples/lgt/channel_targeted_mv_ms_mps.py
The Gauss-resolved MPO is rounded sector by sector before DMRG/TDVP, avoiding the redundant sum-of-products bond without mixing gauge sectors. For the larger N=7 physical-ED flux-convergence reference, run:
PYTHONPATH=. python examples/lgt/dynamical_schwinger_dvr.py --npts 7
Development
Run focused tests from the repository root:
PYTHONPATH=. python -m pytest tests/test_rhf.py -q
Build the documentation with warnings treated as errors:
python -m pip install -r docs/requirements.txt
python -m sphinx -W --keep-going -b html docs/source /tmp/pyqed-docs
Read CONTRIBUTING.md before proposing changes. Scientific changes should include a focused test or reproducible benchmark and document units, conventions, dependencies, and references.
Citing PyQED
Use the metadata in CITATION.cff and record the exact PyQED release or Git commit used. No project DOI is asserted until one appears in an archived release. See the citation guide for a reproducibility checklist.
License
PyQED is distributed under the MIT License. See LICENSE.
Metadata
Release files for pyqed 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyqed-0.3.0.tar.gz | 29.3 MB | With provenance | Details for pyqed-0.3.0.tar.gz |
Built distributions (wheels)
Total release size: 589.5 MB
Release files / pyqed-0.3.0.tar.gz
| Download URL | pyqed-0.3.0.tar.gz |
|---|---|
| Size | 29.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4434a34596bde4270cb195c64685ec02edaea9270d585502fdda8b76984546da
|
|
BLAKE2b-256 checksum How to use checksums |
1b8376ab97d6707140b2816cbd190cd67d125a4cb7963f4906abcfc8d3a42452
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp313-cp313-win_amd64.whl
| Download URL | pyqed-0.3.0-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 31.5 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
f89ec9fe558a844a4f3726b255cfdc3559a447829925ad637f7f3a02d84384cd
|
|
BLAKE2b-256 checksum How to use checksums |
8a8bb46ee318578e8b250e4457b212a615b32a0039c776442d1074987e51a1c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp313-cp313-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
| Download URL | pyqed-0.3.0-cp313-cp313-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 44.5 MB |
| Tags | CPython 3.13 Linux glibc 2.24+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
2f712bbf35f38ab9b942381a6a8fd3eb2dd4edcbdb55f71b6ff2d96340ff98dc
|
|
BLAKE2b-256 checksum How to use checksums |
872b83cbba46a80275d78a39414ec5191bca89b1b7bb7008b9d02d92f898c827
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | pyqed-0.3.0-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 31.8 MB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
56fb59f6a3131440c4f6bd41bcf3e714a6af584adf6f83437640f293366d95d0
|
|
BLAKE2b-256 checksum How to use checksums |
75c0ffb730e09b04f0e6e81a0dcc587c05eeec1369cf6314041ae42a44684b16
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp313-cp313-macosx_10_13_x86_64.whl
| Download URL | pyqed-0.3.0-cp313-cp313-macosx_10_13_x86_64.whl |
|---|---|
| Size | 32.3 MB |
| Tags | CPython 3.13 macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
728e653cad360be7b8aea58343ec39ef1c1dc38db93d2dc4cef090816d7ad04a
|
|
BLAKE2b-256 checksum How to use checksums |
891fa905690bbd216c0d0408c31211374d62d8f641e3b3b5f9c87a8fc3dca4d4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp312-cp312-win_amd64.whl
| Download URL | pyqed-0.3.0-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 31.5 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
2b684fce88bc0afa7c8f6596b4ec57f83a298e9ecc89b12180f5e5ab78a592ea
|
|
BLAKE2b-256 checksum How to use checksums |
8faf0c1648585203d4fd469ebada2bdad0e3fada9010b12717f2699dbbc17bbb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
| Download URL | pyqed-0.3.0-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 44.5 MB |
| Tags | CPython 3.12 Linux glibc 2.24+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
db55fbdc58377ea49539a5d23d0ab210df3fa4bf4f6d59086af94a76bfd13599
|
|
BLAKE2b-256 checksum How to use checksums |
c6772abbe8a653c5270bcb6f7cec3f773e468f7c59454a1d1f6207ff7a854751
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | pyqed-0.3.0-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 31.8 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
f67ca3dba25c4f8a2ba0bc8270876b422ac79f6174576b2f8924ad5210ec1d27
|
|
BLAKE2b-256 checksum How to use checksums |
582f368c1ebb79d7776a81d828a753e9c6ea1a09866fdb0717037fca102a5091
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp312-cp312-macosx_10_13_x86_64.whl
| Download URL | pyqed-0.3.0-cp312-cp312-macosx_10_13_x86_64.whl |
|---|---|
| Size | 32.3 MB |
| Tags | CPython 3.12 macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
6cf5ece44a96b8b6aabf73f01fc1092baf949d242cd48f2d70fa9f531394fb54
|
|
BLAKE2b-256 checksum How to use checksums |
2588322d364842c5e42207db0fe3a8d434d3ae0546fed36203fb5c48dcf7e3b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp311-cp311-win_amd64.whl
| Download URL | pyqed-0.3.0-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 31.5 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
6105872f4f50853fe865de5a2aaf56a798e6cdb5e322fdc59cd1b934300e044b
|
|
BLAKE2b-256 checksum How to use checksums |
90b4624cd8b007ac4e0765c2ea61fcfb19f13e60504861e873a62b71c0c1c1a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
| Download URL | pyqed-0.3.0-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 44.4 MB |
| Tags | CPython 3.11 Linux glibc 2.24+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
a4ae3464a441154cb6dc447429de91eac2665f2affbfc28f9025fe39d380b212
|
|
BLAKE2b-256 checksum How to use checksums |
ee1432cf9e573ce8b5b634595a982e3f1b97fc8ea2b0f32cc8d8e91a3dae822b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | pyqed-0.3.0-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 31.8 MB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
81f770d5a5caa32f8fae1e4f4aabbb05ee0fb63c6ae2e7a3e2156ee8ee8292b0
|
|
BLAKE2b-256 checksum How to use checksums |
f7eabee1d410808ea3994e1eebf94c741531022769cecdf808b743b923358fc6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp311-cp311-macosx_10_9_x86_64.whl
| Download URL | pyqed-0.3.0-cp311-cp311-macosx_10_9_x86_64.whl |
|---|---|
| Size | 32.4 MB |
| Tags | CPython 3.11 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
83f18e3108a889356f9e0a970ab5d5d93cbab98af2fe0caf20cb55a7cb5b35b1
|
|
BLAKE2b-256 checksum How to use checksums |
3c452967e269d489cd02713780f5e84a21120303373a804062b77c6d48e09a58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp310-cp310-win_amd64.whl
| Download URL | pyqed-0.3.0-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 31.5 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
64d17dece15b289f702e3a15d472de61685da7f80a8d1e758199222d67de5f90
|
|
BLAKE2b-256 checksum How to use checksums |
ea277e5dcc3babf9fe0112fbf6fe05c2d321039cd0a7bf62110db920db7915c2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp310-cp310-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
| Download URL | pyqed-0.3.0-cp310-cp310-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl |
|---|---|
| Size | 44.3 MB |
| Tags | CPython 3.10 Linux glibc 2.24+ x86-64 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
a5f9f3c1d5ddf8f9e7b6aa909008c06629b8e83af3410ddfddcdb29fb7b01304
|
|
BLAKE2b-256 checksum How to use checksums |
5f4ab44c326bab25b0cc78f71401891840e28dd433533a6307d31618f3dfc749
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | pyqed-0.3.0-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 31.8 MB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
d1877404bff00746a7bc9c88b6f2045d1faeb4185c9e61411c8bb9bea4dd3dc1
|
|
BLAKE2b-256 checksum How to use checksums |
ed8b9443fe1af94f15062c2978a03fa7754aac01d6382aa2c0cbd4282dd4fbc4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logRelease files / pyqed-0.3.0-cp310-cp310-macosx_10_9_x86_64.whl
| Download URL | pyqed-0.3.0-cp310-cp310-macosx_10_9_x86_64.whl |
|---|---|
| Size | 32.4 MB |
| Tags | CPython 3.10 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
993e63763f72ac12e4d73d9a92d927cf78737e7c33ab6a936e554c4e2b6c1cf0
|
|
BLAKE2b-256 checksum How to use checksums |
88f0c790ab137d1428d744be82a22584f519108a6a6dffa0844a4af90fcaadce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logSecurity for pyqed 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 17 files in this release have been uploaded with provenance metadata.
Attestation for pyqed-0.3.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 2, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.