Skip to main content

RydState - A Rydberg State Calculator

PyPI Package License: LGPL v3 CI Workflow Documentation

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 rydstate

To install the latest development version from github, use:

pip install git+https://github.com/pairinteraction/rydstate

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 Sr88_sqdt 10.1103/PhysRevA.108.022815 (2023)
10.17169/refubium-34581 (2022)
10.1016/j.cpc.2020.107814 (2021)
Sr87 MQDT Sr87_mqdt 10.1088/1361-6455/ab4c22 (2019)
Sr88 MQDT Sr88_mqdt 10.1088/1361-6455/ab4c22 (2019)
Yb171 MQDT Yb171_mqdt 10.1103/PhysRevX.15.011009 (2025)
10.1103/mzsv-rckx (2025)
Yb173 MQDT Yb173_mqdt MQDT model formulated by Frederic Hummel
Yb174 MQDT Yb174_mqdt 10.1103/PhysRevX.15.011009 (2025)
10.1103/mzsv-rckx (2025)

Documentation

User Guide

  • Tutorials - Examples of how to use the RydState library.

  • API Reference - Documentation of classes and functions of the RydState Python library.

Contributors

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!

License

The rydstate software is licensed under LGPL v3. For more information, see LICENSE.txt.

Download files

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

Source Distribution

rydstate-0.12.2.tar.gz (147.5 kB view details)

Uploaded Source

Built Distribution

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

rydstate-0.12.2-py3-none-any.whl (155.5 kB view details)

Uploaded Python 3

File details

Details for the file rydstate-0.12.2.tar.gz.

File metadata

  • Download URL: rydstate-0.12.2.tar.gz
  • Upload date:
  • Size: 147.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for rydstate-0.12.2.tar.gz
Algorithm Hash digest
SHA256 529f44328537e9925c58397c544ad6dc98bf63b163169154fb94ffb22aeedb7b
MD5 80b13823a1a7d402eff21651274a46c3
BLAKE2b-256 a6bc83ae0d0f4b9e9b212390be3da83b1afea66694fe16b24abd9ba8683f17b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for rydstate-0.12.2.tar.gz:

Publisher: publish.yml on pairinteraction/rydstate

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

File details

Details for the file rydstate-0.12.2-py3-none-any.whl.

File metadata

  • Download URL: rydstate-0.12.2-py3-none-any.whl
  • Upload date:
  • Size: 155.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for rydstate-0.12.2-py3-none-any.whl
Algorithm Hash digest
SHA256 15d6159fc775ddfb15634f61774ae993f60735c1e6af17648546a737284fa221
MD5 0f7cf664de01f86b13f4572e067e628a
BLAKE2b-256 ed44f4d4e8e9bb943fb33c02da17bb78cc0eaf3bdaf030c0fd7df0e1e5486c9a

See more details on using hashes here.

Provenance

The following attestation bundles were made for rydstate-0.12.2-py3-none-any.whl:

Publisher: publish.yml on pairinteraction/rydstate

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page