Skip to main content
PyPI release Documentation status MIT license

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 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyqed-0.3.0.tar.gz (29.3 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

pyqed-0.3.0-cp313-cp313-win_amd64.whl (31.5 MB view details)

Uploaded CPython 3.13Windows x86-64

pyqed-0.3.0-cp313-cp313-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (44.5 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

pyqed-0.3.0-cp313-cp313-macosx_11_0_arm64.whl (31.8 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

pyqed-0.3.0-cp313-cp313-macosx_10_13_x86_64.whl (32.3 MB view details)

Uploaded CPython 3.13macOS 10.13+ x86-64

pyqed-0.3.0-cp312-cp312-win_amd64.whl (31.5 MB view details)

Uploaded CPython 3.12Windows x86-64

pyqed-0.3.0-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (44.5 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

pyqed-0.3.0-cp312-cp312-macosx_11_0_arm64.whl (31.8 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

pyqed-0.3.0-cp312-cp312-macosx_10_13_x86_64.whl (32.3 MB view details)

Uploaded CPython 3.12macOS 10.13+ x86-64

pyqed-0.3.0-cp311-cp311-win_amd64.whl (31.5 MB view details)

Uploaded CPython 3.11Windows x86-64

pyqed-0.3.0-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (44.4 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

pyqed-0.3.0-cp311-cp311-macosx_11_0_arm64.whl (31.8 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

pyqed-0.3.0-cp311-cp311-macosx_10_9_x86_64.whl (32.4 MB view details)

Uploaded CPython 3.11macOS 10.9+ x86-64

pyqed-0.3.0-cp310-cp310-win_amd64.whl (31.5 MB view details)

Uploaded CPython 3.10Windows x86-64

pyqed-0.3.0-cp310-cp310-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (44.3 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

pyqed-0.3.0-cp310-cp310-macosx_11_0_arm64.whl (31.8 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

pyqed-0.3.0-cp310-cp310-macosx_10_9_x86_64.whl (32.4 MB view details)

Uploaded CPython 3.10macOS 10.9+ x86-64

File details

Details for the file pyqed-0.3.0.tar.gz.

File metadata

  • Download URL: pyqed-0.3.0.tar.gz
  • Upload date:
  • Size: 29.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyqed-0.3.0.tar.gz
Algorithm Hash digest
SHA256 4434a34596bde4270cb195c64685ec02edaea9270d585502fdda8b76984546da
MD5 c6a1ea54e3b82224749ff27accc4e35a
BLAKE2b-256 1b8376ab97d6707140b2816cbd190cd67d125a4cb7963f4906abcfc8d3a42452

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0.tar.gz:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp313-cp313-win_amd64.whl.

File metadata

  • Download URL: pyqed-0.3.0-cp313-cp313-win_amd64.whl
  • Upload date:
  • Size: 31.5 MB
  • Tags: CPython 3.13, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyqed-0.3.0-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 f89ec9fe558a844a4f3726b255cfdc3559a447829925ad637f7f3a02d84384cd
MD5 7ace5deea3b03755dc57c7b5bb5a14fe
BLAKE2b-256 8a8bb46ee318578e8b250e4457b212a615b32a0039c776442d1074987e51a1c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp313-cp313-win_amd64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp313-cp313-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp313-cp313-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 2f712bbf35f38ab9b942381a6a8fd3eb2dd4edcbdb55f71b6ff2d96340ff98dc
MD5 5e7b9f59a84c7ab5ef3cb5c683bd5885
BLAKE2b-256 872b83cbba46a80275d78a39414ec5191bca89b1b7bb7008b9d02d92f898c827

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp313-cp313-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 56fb59f6a3131440c4f6bd41bcf3e714a6af584adf6f83437640f293366d95d0
MD5 fdd1a438ead5dd3f37048223d1562a94
BLAKE2b-256 75c0ffb730e09b04f0e6e81a0dcc587c05eeec1369cf6314041ae42a44684b16

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp313-cp313-macosx_11_0_arm64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp313-cp313-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 728e653cad360be7b8aea58343ec39ef1c1dc38db93d2dc4cef090816d7ad04a
MD5 cb6448e43eca4613e398a64ea821dce9
BLAKE2b-256 891fa905690bbd216c0d0408c31211374d62d8f641e3b3b5f9c87a8fc3dca4d4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp313-cp313-macosx_10_13_x86_64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp312-cp312-win_amd64.whl.

File metadata

  • Download URL: pyqed-0.3.0-cp312-cp312-win_amd64.whl
  • Upload date:
  • Size: 31.5 MB
  • Tags: CPython 3.12, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyqed-0.3.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 2b684fce88bc0afa7c8f6596b4ec57f83a298e9ecc89b12180f5e5ab78a592ea
MD5 836100c8c3e51b43bf38a8fd0b81f185
BLAKE2b-256 8faf0c1648585203d4fd469ebada2bdad0e3fada9010b12717f2699dbbc17bbb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp312-cp312-win_amd64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 db55fbdc58377ea49539a5d23d0ab210df3fa4bf4f6d59086af94a76bfd13599
MD5 ad47442e164008c16f80af144e0aaf80
BLAKE2b-256 c6772abbe8a653c5270bcb6f7cec3f773e468f7c59454a1d1f6207ff7a854751

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f67ca3dba25c4f8a2ba0bc8270876b422ac79f6174576b2f8924ad5210ec1d27
MD5 0a5cfd8424de9996ffaaebc8a3a21e24
BLAKE2b-256 582f368c1ebb79d7776a81d828a753e9c6ea1a09866fdb0717037fca102a5091

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp312-cp312-macosx_11_0_arm64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp312-cp312-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 6cf5ece44a96b8b6aabf73f01fc1092baf949d242cd48f2d70fa9f531394fb54
MD5 e0b84cbada824b6f4c72a973f96bd1e5
BLAKE2b-256 2588322d364842c5e42207db0fe3a8d434d3ae0546fed36203fb5c48dcf7e3b7

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp312-cp312-macosx_10_13_x86_64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp311-cp311-win_amd64.whl.

File metadata

  • Download URL: pyqed-0.3.0-cp311-cp311-win_amd64.whl
  • Upload date:
  • Size: 31.5 MB
  • Tags: CPython 3.11, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyqed-0.3.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 6105872f4f50853fe865de5a2aaf56a798e6cdb5e322fdc59cd1b934300e044b
MD5 be962d4d0a43e0951d503147eb1aaf75
BLAKE2b-256 90b4624cd8b007ac4e0765c2ea61fcfb19f13e60504861e873a62b71c0c1c1a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp311-cp311-win_amd64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a4ae3464a441154cb6dc447429de91eac2665f2affbfc28f9025fe39d380b212
MD5 8da175fb62d31ba9f71eafc298d3fa91
BLAKE2b-256 ee1432cf9e573ce8b5b634595a982e3f1b97fc8ea2b0f32cc8d8e91a3dae822b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 81f770d5a5caa32f8fae1e4f4aabbb05ee0fb63c6ae2e7a3e2156ee8ee8292b0
MD5 208b112dda870cf11e782445d4e2813e
BLAKE2b-256 f7eabee1d410808ea3994e1eebf94c741531022769cecdf808b743b923358fc6

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp311-cp311-macosx_11_0_arm64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp311-cp311-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 83f18e3108a889356f9e0a970ab5d5d93cbab98af2fe0caf20cb55a7cb5b35b1
MD5 fb653dcd477ef7dbb299b762f726b7b9
BLAKE2b-256 3c452967e269d489cd02713780f5e84a21120303373a804062b77c6d48e09a58

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp311-cp311-macosx_10_9_x86_64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp310-cp310-win_amd64.whl.

File metadata

  • Download URL: pyqed-0.3.0-cp310-cp310-win_amd64.whl
  • Upload date:
  • Size: 31.5 MB
  • Tags: CPython 3.10, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyqed-0.3.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 64d17dece15b289f702e3a15d472de61685da7f80a8d1e758199222d67de5f90
MD5 1f73ca05ebe6c04a62ae42da355b7b4e
BLAKE2b-256 ea277e5dcc3babf9fe0112fbf6fe05c2d321039cd0a7bf62110db920db7915c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp310-cp310-win_amd64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp310-cp310-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp310-cp310-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a5f9f3c1d5ddf8f9e7b6aa909008c06629b8e83af3410ddfddcdb29fb7b01304
MD5 39abf59248fc02bad95880277dc4a15b
BLAKE2b-256 5f4ab44c326bab25b0cc78f71401891840e28dd433533a6307d31618f3dfc749

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp310-cp310-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d1877404bff00746a7bc9c88b6f2045d1faeb4185c9e61411c8bb9bea4dd3dc1
MD5 8164c55708e7f853db4376fff358a783
BLAKE2b-256 ed8b9443fe1af94f15062c2978a03fa7754aac01d6382aa2c0cbd4282dd4fbc4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp310-cp310-macosx_11_0_arm64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyqed-0.3.0-cp310-cp310-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for pyqed-0.3.0-cp310-cp310-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 993e63763f72ac12e4d73d9a92d927cf78737e7c33ab6a936e554c4e2b6c1cf0
MD5 3ca1b399b1ec0203cee8c668c2ec9bcb
BLAKE2b-256 88f0c790ab137d1428d744be82a22584f519108a6a6dffa0844a4af90fcaadce

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyqed-0.3.0-cp310-cp310-macosx_10_9_x86_64.whl:

Publisher: release.yml on binggu56/pyqed

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.0 This release

17 files

0.2.0

2 files

0.1.5

1 file

0.1.4

1 file

0.1.3

1 file

0.1.2

2 files

0.1.1

2 files

0.1.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page