Rydberg Numerov
The Rydberg Numerov 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.9):
pip install ryd-numerov
To install the latest development version from github, use:
pip install git+https://github.com/pairinteraction/ryd-numerov
How to Cite
This package relies on quantum defects provided by the community. Consider citing relevant publications for your atomic species.
Click to expand for quantum defect references
| Element | Model | Identifier | References |
|---|---|---|---|
| H | SQDT | H |
Schrödinger equation for hydrogen |
| Li | SQDT | Li |
10.1017/CBO9780511524530 (1994) 10.1103/PhysRevA.34.2889 (1986) |
| Na | SQDT | Na |
10.1088/0953-4075/30/10/009 (1997) 10.1070/QE1995v025n09ABEH000501 (1995) 10.1103/PhysRevA.45.4720 (1992) |
| K | SQDT | K |
10.1088/0031-8949/27/4/012 (1983) 10.1016/0030-4018(81)90225-X (1981) |
| Rb | SQDT | Rb |
10.1103/PhysRevA.83.052515 (2011) 10.1103/PhysRevA.74.054502 (2006) 10.1103/PhysRevA.74.062712 (2006) 10.1103/PhysRevA.67.052502 (2003) |
| Cs | SQDT | Cs |
10.1103/PhysRevA.93.013424 (2016) 10.1103/PhysRevA.35.4650 (1987) 10.1103/PhysRevA.26.2733 (1982) |
| Sr88 | SQDT, singlet sector | Sr88 |
10.1103/PhysRevA.108.022815 (2023) 10.17169/refubium-34581 (2022) |
| Sr88 | SQDT, triplet sector | Sr88 |
10.1016/j.cpc.2020.107814 (2021) |
Documentation
User Guide
-
Tutorials - Examples of how to use the Rydberg Numerov library.
-
API Reference - Documentation of classes and functions of the Rydberg Numerov Python library.
Using custom quantum defects
To use custom quantum defects (or quantum defects for a new element), you can simply create a subclass of ryd_numerov.elements.base_element.BaseElement (e.g. class CustomRubidium(BaseElement):) with a custom species name (e.g. species = "Custom_Rb").
Then, similarly to ryd_numerov.elements.rubidium.py you can define the quantum defects (and model potential parameters, ...) for your element.
Finally, you can use the custom element by simply calling ryd_numerov.RydbergState("Custom_Rb", n=50, l=0, j_tot=1/2, m=1/2) (the code will look for all subclasses of BaseElement until it finds one with the species name "Custom_Rb").
License
The ryd-numerov software is licensed under LGPL v3. For more information, see LICENSE.txt.
1 maintainer
Metadata
1 maintainer
Release files for ryd-numerov 0.8.1
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 |
|---|---|---|---|---|
| ryd_numerov-0.8.1.tar.gz | 74.4 kB | With provenance | Details for ryd_numerov-0.8.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ryd_numerov-0.8.1-py3-none-any.whl | Python 3 | none | any | Details for ryd_numerov-0.8.1-py3-none-any.whl |
Total release size: 156.1 kB
Release files / ryd_numerov-0.8.1.tar.gz
| Download URL | ryd_numerov-0.8.1.tar.gz |
|---|---|
| Size | 74.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b9cbe8af2c2a472dbe390ee105f02252c762532e36b970844182bcecf71499ef
|
|
BLAKE2b-256 checksum How to use checksums |
52dcd1cec1b67431975011dbf52d217a3fe135a6a8d5f4841559f64350a55410
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 17, 2025.
Transparency logRelease files / ryd_numerov-0.8.1-py3-none-any.whl
| Download URL | ryd_numerov-0.8.1-py3-none-any.whl |
|---|---|
| Size | 81.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8cfddc813f73c7353c68cd4621dd1a575731d26a34481fd1c58aeb8e46633961
|
|
BLAKE2b-256 checksum How to use checksums |
0bcc8cd5ecdbfe370722af4770a9189df122ce822618e0b194eea74fc4b3a0d2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
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 17, 2025.
Transparency logSecurity for ryd-numerov 0.8.1
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 2 files in this release have been uploaded with provenance metadata.
Attestation for ryd_numerov-0.8.1.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 17, 2025.
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.
