Skip to main content

A Rydberg Interaction Calculator

Project description

Pairinteraction - A Rydberg Interaction Calculator

PyPI Package arXiv:1612.08053 License: LGPL v3 CI Workflow Quality Gate Status C++ Coverage - ctest C++ Coverage - pytest Python Coverage - pytest Documentation

Note: This is a completely new version of the pairinteraction software that is not backward compatible to versions below v1.0.

The pairinteraction software calculates properties of Rydberg atoms. The software consists of a Python library and a graphical user interface for obtaining single-atom properties and calculating pair potentials, making use of a high-performance C++ backend. For a more detailed description of the software that is written to be accessible also to non-specialists, see the About page of the project. The software can be installed via pip (requires Python >= 3.9, for tips see our extended installation instructions):

pip install pairinteraction

You can use the pairinteraction software as a Python library, see our quick start guide to get started in 5 minutes, or you can launch its graphical user interface from the command line:

pairinteraction gui

Highlights

  • For calculating Rydberg pair potentials, the software uses a similar approach as the old version of pairinteraction, the Alkali.ne Rydberg Calculator, and the rydcalc library. We optimized the construction and diagonalization of Hamiltonians, typically achieving a speedup of 5-20x compared to other implementations.

    benchmarking results

    Figure: Benchmarking the construction and diagonalization of a Hamiltonian of a pair of Rb 60S atoms for 100 different internuclear distances on an AMD Ryzen 7 5700G CPU using Windows 11. The Hilbert space comprises pair states that differ at most by 4 in n, l and 25GHz in energy. When supported, symmetries where used to reduce the Hilbert space size. See the benchmarking tool.

  • The software uses single-channel quantum defect theory (SQDT) and also multi-channel quantum defect theory (MQDT) for the accurate description of atoms.

    The construction of Hamiltonians is accelerated by using pre-calculated matrix elements, which are stored in database tables. These tables are automatically downloaded from GitHub [1,2] and cached locally when needed.

  • Electric and magnetic fields in arbitrary directions can be included in the calculations. Diamagnetism is supported.

How to Cite

If you use pairinteraction in your research, please cite our tutorial paper:

Sebastian Weber, Christoph Tresp, Henri Menke, Alban Urvoy, Ofer Firstenberg, Hans Peter Büchler, Sebastian Hofferberth, Tutorial: Calculation of Rydberg interaction potentials, J. Phys. B: At. Mol. Opt. Phys. 50, 133001 (2017), arXiv:1612.08053

Quantum Defects

Pairinteraction relies on quantum defects provided by the community. Consider citing relevant publications for your atomic species alongside pairinteraction.

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_singlet 10.1103/PhysRevA.108.022815 (2023)
10.17169/refubium-34581 (2022)
Sr88 SQDT, triplet sector Sr88_triplet 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.48550/arXiv.2406.01482 (2024)
Yb173 MQDT Yb173_mqdt MQDT model formulated by us
Yb174 MQDT Yb174_mqdt 10.48550/arXiv.2406.01482 (2024)

The identifier can be used to specify an atomic species in the pairinteraction software.

Documentation

User Guide

  • Installation - Whether you prefer an installation via pip or compiling from source, we've got all the information you need.

  • Tutorials - Covering both the graphical user interface and the Python library, these tutorials enable you to leverage pairinteraction for your projects.

  • API Reference - Documentation of classes and functions of pairinteraction's Python library.

  • Publications - Find out more about the theory behind pairinteraction and how to cite it and the quantum defects you use.

Contributor Guide

Utility Tools [External Links]

  • MQDT.jl - Learn how to calculate states and matrix elements using multi-channel quantum defect theory with our tool written in Julia.

  • ryd-numerov - Learn how to calculate states and matrix elements using single quantum defect theory with our tool written in Python.

Contributors

The software is maintained by:

In addition, the following people contributed significantly to the current and/or previous versions of the software:

  • Henri Menke
  • Frederic Hummel - Julia package for multi-channel quantum defect theory, matrix elements
  • Eduard J. Braun - Perturbative calculations, installation instructions for Windows
  • Johannes Block - Calculation of Rydberg pair potentials near surfaces (not yet in new version)
  • Nicolas Zuber - Tutorial on Rydberg-ion interaction
  • Simon Hollerith - Documentation of the graphical user interface (not yet in new version)

We warmly welcome new contributions! Please see our contributor guide for more information!

The development of the pairinteraction software has been supported by the Institute for Theoretical Physics III of the University of Stuttgart, the Federal Ministry of Education and Research under the Grants QRydDemo and MUNIQC-Atoms, and the company Atom Computing. The development of the original version of the software started at the 5th Institute of Physics of the University of Stuttgart.

University of Stuttgart Federal Ministry of Education and Research Atom Computing

License

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

Project details


Download files

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

Source Distribution

pairinteraction-2.2.0.tar.gz (505.4 kB view details)

Uploaded Source

Built Distributions

pairinteraction-2.2.0-cp312-abi3-win_amd64.whl (14.8 MB view details)

Uploaded CPython 3.12+Windows x86-64

pairinteraction-2.2.0-cp312-abi3-manylinux_2_28_x86_64.whl (64.6 MB view details)

Uploaded CPython 3.12+manylinux: glibc 2.28+ x86-64

pairinteraction-2.2.0-cp312-abi3-macosx_13_0_x86_64.whl (44.4 MB view details)

Uploaded CPython 3.12+macOS 13.0+ x86-64

pairinteraction-2.2.0-cp312-abi3-macosx_13_0_arm64.whl (43.0 MB view details)

Uploaded CPython 3.12+macOS 13.0+ ARM64

pairinteraction-2.2.0-cp311-cp311-win_amd64.whl (14.8 MB view details)

Uploaded CPython 3.11Windows x86-64

pairinteraction-2.2.0-cp311-cp311-manylinux_2_28_x86_64.whl (64.7 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.28+ x86-64

pairinteraction-2.2.0-cp311-cp311-macosx_13_0_x86_64.whl (44.4 MB view details)

Uploaded CPython 3.11macOS 13.0+ x86-64

pairinteraction-2.2.0-cp311-cp311-macosx_13_0_arm64.whl (43.0 MB view details)

Uploaded CPython 3.11macOS 13.0+ ARM64

pairinteraction-2.2.0-cp310-cp310-win_amd64.whl (14.8 MB view details)

Uploaded CPython 3.10Windows x86-64

pairinteraction-2.2.0-cp310-cp310-manylinux_2_28_x86_64.whl (64.7 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.28+ x86-64

pairinteraction-2.2.0-cp310-cp310-macosx_13_0_x86_64.whl (44.4 MB view details)

Uploaded CPython 3.10macOS 13.0+ x86-64

pairinteraction-2.2.0-cp310-cp310-macosx_13_0_arm64.whl (43.0 MB view details)

Uploaded CPython 3.10macOS 13.0+ ARM64

pairinteraction-2.2.0-cp39-cp39-win_amd64.whl (14.8 MB view details)

Uploaded CPython 3.9Windows x86-64

pairinteraction-2.2.0-cp39-cp39-manylinux_2_28_x86_64.whl (64.7 MB view details)

Uploaded CPython 3.9manylinux: glibc 2.28+ x86-64

pairinteraction-2.2.0-cp39-cp39-macosx_13_0_x86_64.whl (44.4 MB view details)

Uploaded CPython 3.9macOS 13.0+ x86-64

pairinteraction-2.2.0-cp39-cp39-macosx_13_0_arm64.whl (43.0 MB view details)

Uploaded CPython 3.9macOS 13.0+ ARM64

File details

Details for the file pairinteraction-2.2.0.tar.gz.

File metadata

  • Download URL: pairinteraction-2.2.0.tar.gz
  • Upload date:
  • Size: 505.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pairinteraction-2.2.0.tar.gz
Algorithm Hash digest
SHA256 eb86fffad99082bf1f0c1f19eef874736d416b2cd2a1c2bae6d72690754119ab
MD5 dc0b0dd98f5ced2b7b0ad157a95a6eb1
BLAKE2b-256 d1cd7b4508d01a5545bfaffac7e78656f7ee8253ad32a16d37025c178a7954f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0.tar.gz:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp312-abi3-win_amd64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp312-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 358fe24b7b30a79ee540752c236e1ce2eb6bb4efa8ecaabaf64a2c11e9e7ed7b
MD5 3524a8187e363487cd2f5796c830266e
BLAKE2b-256 ac9426c929585c7c1cbdd11d10120b5d113ff6f19869fd6a8dca6509fcf0d723

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp312-abi3-win_amd64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp312-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp312-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 c853b373fa940579c5555ca22c51d3b1378f97b2f1a58d5933d6110a305cb873
MD5 78d7f42b090c03b19493538b2802a4a2
BLAKE2b-256 b46ee9148fd1982026f10e00b9ba4c9a3b665ed791239e35c734f46b5fb9d2eb

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp312-abi3-manylinux_2_28_x86_64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp312-abi3-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp312-abi3-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 c6565b0bd84e4ed7b338bfa97cd56bb20b2e9c34f72a51af28c470a2d839042b
MD5 32d521ca4365880d9a9dd2ecfcf1ed80
BLAKE2b-256 d094f1e55d41f8cb844fa054fe5f6cec1632afd2452f491c5addfff3ab6ba6f5

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp312-abi3-macosx_13_0_x86_64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp312-abi3-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp312-abi3-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 471654a8cbf163365748c0c5de35bfdebcf27bf86d0e0cdfd87b837720507e05
MD5 7b0c810bfd5f50cc2ec1329460556c93
BLAKE2b-256 89750a42505f69d59485842ad08f9e9185ddcfc699e6507437d63193fb22538a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp312-abi3-macosx_13_0_arm64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 248eef4ef5fde3c653b637bb1951b3fa11c75be59732467de0463ada7c7a150e
MD5 7253f17253168b3e999f6e788c07e40b
BLAKE2b-256 72ab3b042204030b5311fc15c9ffe673a834fe36208036ce7906890d827b9b6d

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp311-cp311-win_amd64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp311-cp311-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 8164c66ed942c9be4ffcd1546ae3698efb49479334bbe60c84f1e2bd507cf59f
MD5 a74670ebd1ccba131a74897bb8bcc6ba
BLAKE2b-256 eb425485dbf1482ba2c665df3a7424fbc80ae3c70fd123de9c6ba4530cd1777e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp311-cp311-manylinux_2_28_x86_64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp311-cp311-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp311-cp311-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 98667b1b50a46e7390e6816c3b1bc9c4a6dce42e0021bf20e1cef75c6a3068c6
MD5 11727d975caeb545735c3773d196ad36
BLAKE2b-256 42ca403ab427d046d5c1ce8b1527488e7d2359a415a4ad9235f33408022781c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp311-cp311-macosx_13_0_x86_64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp311-cp311-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp311-cp311-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 0d6eb9b37df76d9799f85d663633ff965beeceb3dc5db1fd845b84c351d1e19d
MD5 be47e383aec6c72d65cbd1a4078d529e
BLAKE2b-256 dc2510219964116a16e44be5b113c158b818d1a932490eb68695e5f3956690c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp311-cp311-macosx_13_0_arm64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 f7466d9a057d9c71e7f2192398577af17fff8b03182684cd280646116fede9e1
MD5 b6a15b9cb399a2f95f76985e21a9ed9d
BLAKE2b-256 b8b478d7f89bad4b509cd1d945a88caccbb727499f70d6de22bdccb7ae6f0e96

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp310-cp310-win_amd64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp310-cp310-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 348b0952145c7d8b52ce25f99d318924b3dc542eb95c60e8d99d11e122bdd50b
MD5 a6315f1ab178e1d45b4aac97bbe26b66
BLAKE2b-256 7e0a49b2aae63d2b981b5741f0ef4d8214b67e2fa92ed4ab05cb63ece2a1a740

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp310-cp310-manylinux_2_28_x86_64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp310-cp310-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp310-cp310-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 b414411e26997e9b59a5049c0a2429b56bee733214a1dcd91320db517d6fceb9
MD5 13922c94b40489965f9931dca94daba7
BLAKE2b-256 e49f3e079abdc543a68eae3c0fd13aa3a67c1de741d56a75850be37708243045

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp310-cp310-macosx_13_0_x86_64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp310-cp310-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp310-cp310-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 6170d97c69022d513e0ff235630723ffc54db2165c44636ccaf3c7bbeb2dc7ae
MD5 435976707701ebd7d64c367272b8cefc
BLAKE2b-256 ff833ff70b750b6507b7499ecb948d123d1029cffedfd145ca93daeae75ed722

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp310-cp310-macosx_13_0_arm64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp39-cp39-win_amd64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 78165ad1e50e4dfbdd0963c635c0180e5b469c45bdec421ecfd2009cfebd322d
MD5 1a1bd82e8f6df55ddd0ad4b4bcb76328
BLAKE2b-256 0891bf4d05f26149cadbe81ddeefe33f2cbd0f2216d69b13bc71c70bd957284a

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp39-cp39-win_amd64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp39-cp39-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp39-cp39-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 c7b172c286e1bfd72edb5d33519bef246ce5d7db454e9b422034d6ed808fb8c0
MD5 dadca2749df05212b2b4679ece931ca8
BLAKE2b-256 c712bdadf04370318dc9c08dacacccc440a64abe017398e836706af4078bbdb1

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp39-cp39-manylinux_2_28_x86_64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp39-cp39-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp39-cp39-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 934f69d91e6d0a7576d1b1a712bb1166309e4791eea4c55fbff48b09d1d56f42
MD5 16049f1cdb944b511968c4814f8f7cb2
BLAKE2b-256 4906f7c5152cd145a60ee6d1e41c1caa8f9fcae298613fe8fa9278e406e04c8f

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp39-cp39-macosx_13_0_x86_64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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

File details

Details for the file pairinteraction-2.2.0-cp39-cp39-macosx_13_0_arm64.whl.

File metadata

File hashes

Hashes for pairinteraction-2.2.0-cp39-cp39-macosx_13_0_arm64.whl
Algorithm Hash digest
SHA256 4f79dd8f7006786e18286c5d2e8190b960d78da2bd7ae6698900a303d884658e
MD5 26b4fee46c4b6570e28aea1199769e20
BLAKE2b-256 5b3d4b0702baa34427c82e159a91757175d9d2d7458dac07ddadc8aeb680996b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pairinteraction-2.2.0-cp39-cp39-macosx_13_0_arm64.whl:

Publisher: publish-pypi.yml on pairinteraction/pairinteraction

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 Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page