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)
Sr88+ SQDT Sr88_ion urn:nbn:se:su:diva-184811 (2020)
10.1007/978-3-030-33770-4 (2019)
10.1007/BF01426593 (1991)
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.

Metadata

Release files for rydstate 0.14.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rydstate 0.14.0
File Size Uploaded
rydstate-0.14.0.tar.gz 198.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for rydstate 0.14.0
File Interpreter ABI Platform
rydstate-0.14.0-py3-none-any.whl Python 3 none any Details

Total release size: 391.2 kB

Release files / rydstate-0.14.0.tar.gz

Download URL rydstate-0.14.0.tar.gz
Size 198.6 kB
Tags Source
SHA-256 checksum
How to use checksums
49713daa7d98bdd699a589f0d2d8677deb77d0175a1eabd65d8c9f26d800151e
BLAKE2b-256 checksum
How to use checksums
33395398858f8ab6008e7fe40870163e21a547cb2156793eecef50098a46591b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 14, 2026.

Transparency log

Release files / rydstate-0.14.0-py3-none-any.whl

Download URL rydstate-0.14.0-py3-none-any.whl
Size 192.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
62ef7bc706961ef52ca628dc9496ec2d51c88db7788e472e73f3cdeddf8e291b
BLAKE2b-256 checksum
How to use checksums
c441dd69a35c649b8cb2e10c2fa87c5abc77046538e8f54d1c887bab8d5d05d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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 14, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.14.0 This release

2 release files

0.13.0

2 release files

0.12.0

2 release files

0.11.0

2 release files

0.10.0

2 release files

0.9.2

2 release files

0.9.1

2 release files

0.9.0

2 release files

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