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/
- Source: https://github.com/binggu56/pyqed
- Issue tracker: https://github.com/binggu56/pyqed/issues
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.
Install a published release from PyPI:
python -m pip install pyqedFor the current development tree:
git clone https://github.com/binggu56/pyqed.git
cd pyqed
python -m pip install -e .Standard installations use the tested pure-Python fallbacks. To compile the optional native accelerators from a source checkout, use a supported C/C++ toolchain and opt in explicitly:
PYQED_BUILD_EXTENSIONS=1 python -m pip install .Use documentation from the same release or commit as the installed code. See the installation guide for verification and optional-dependency guidance.
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(driver="builtin", eri="auto")
mf = mol.RHF().run()
print("converged:", mf.converged)
print("RHF energy:", mf.e_tot)Continue with the quickstart and the examples gallery.
Run focused tests from the repository root:
PYTHONPATH=. python -m pytest tests/test_rhf.py -qBuild 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-docsRead CONTRIBUTING.md before proposing changes. Scientific changes should include a focused test or reproducible benchmark and document units, conventions, dependencies, and references.
If you use PyQED in your research, please cite:
Yujuan Xie, Xiaotong Zhu, and Bing Gu. PyQED: A Python Framework for Ab Initio Geometric Quantum Dynamics. Chinese Journal of Chemical Physics (2026). DOI: 10.1063/1674-0068/cjcp2510161.
PyQED is distributed under the MIT License. See LICENSE.