The RydState software calculates properties of Rydberg states. We especially focus on the calculation of the radial wavefunction of Rydberg states via the Numerov method. The software can be installed via pip (requires Python >= 3.10):
pip install rydstateTo install the latest development version from github, use:
pip install git+https://github.com/pairinteraction/rydstateThis package relies on quantum defects provided by the community. Consider citing relevant publications for your atomic species.
Click to expand for quantum defect references
User Guide
-
Tutorials - Examples of how to use the RydState library.
-
API Reference - Documentation of classes and functions of the RydState Python library.
To use custom quantum defects (or quantum defects for a new species), you can simply create a subclass of rydstate.species.SpeciesObjectSQDT (e.g. class CustomRubidium(SpeciesObjectSQDT):) with a custom species name (e.g. name = "Custom_Rb").
Then, similarly to rydstate.species.sqdt.rubidium.py you can define the quantum defects (and model potential parameters, ...) for your species.
Finally, you can use the custom species by simply calling rydstate.RydbergStateSQDTAlkali("Custom_Rb", n=50, l=0, j=1/2, m=1/2) (the code will look for all subclasses of SpeciesObjectSQDT until it finds one with the species name "Custom_Rb").
This software is currently maintained by:
The following people have made significant contributions:
- Frederic Hummel - Supported the development of the MQDT implementation. Author of the MQDT.jl Julia package, on which this package’s Python implementation of the MQDT calculations is based.
- Sebastian Weber - Provided substantial input on the physics and software architecture of this package.
We warmly welcome new contributions!
The rydstate software is licensed under LGPL v3. For more information, see LICENSE.txt.