135zhangyu / arc-alkali-rydberg-calculator

Object-oriented Python library for computation of properties of highly-excited Rydbeg states of alkali and divalent atoms.

ARC (Alkali.ne Rydberg Calculator)

ARC (Alkali.ne Rydberg Calculator) is package of routines written in Python, using object-oriented programming (OOP) to make modular, reusable and extendable collection of routines and data for performing useful calculations of single atom and two-atom properties, like level diagrams, interactions and transition strengths for alkali metal and divalent atoms.

Start by installing the latest version of the ARC package calling Python pip (see prerequisites) from the command line:

pip install ARC-Alkali-Rydberg-Calculator

For documentation see online documentation on Read The Docs.

For examples of use check IPython example notebooks.

For online access to a selection of package functions see online Atom Calculator.

If you want to contribute to the project, check this page.

---

Authors

Nikola Šibalić, Elizabeth J. Robertson, Jonathan D. Pritchard, Robert M. Potvliege, Matthew P. A. Jones, Charles S. Adams, Kevin J. Weatherill and contributors

Please cite as:

The simplest way to obtain correct reference(s), given the number of contributions, is to call - at the end of your Python script that uses ARC - following function

from arc import *
# use ARC
print(getCitationForARC())

The getCitationForARC() will print references that introduced methods you used into ARC library. Otherwise, you can do manual decision making based on the logic below:

If you use alkali atoms: N. Šibalić, J. D. Pritchard, K. J. Weatherill, C. S. Adams, ARC: An open-source library for calculating properties of alkali Rydberg atoms, Computer Physics Communications 220, 319 (2017), https://doi.org/10.1016/j.cpc.2017.06.015

If you use divalent atoms (Sr, Ca, Yb ...) or new featutures from ARC 3.0: E. J. Robertson, N. Šibalić, R. M. Potvliege, M. P. A. Jones, ARC 3.0: An expanded Python toolbox for atomic physics calculations, Computer Physics Communications 261, 107814 (2021) https://doi.org/10.1016/j.cpc.2020.107814

In addition to main reference above: If you are using modules from arc.advanced please paper that introduced relevant ARC extension.

If you are using modules AC Stark calculations ShirleyMethod or RWAStarkShift please also cite D. H. Meyer, Z. A. Castillo, K. C. Cox, P. D. Kunz, J. Phys. B: At. Mol. Opt. Phys., 53, 034001 (2020) .

Who are the users of this library? Check papers that cite us in ADS and Google Scholar.

---

License

All the files distributed with this program are provided subject to the BSD-3-Clause license. A copy of the license is provided.