ARC documentation

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 and divalent atoms.

Contents

• Installation instructions
  • Prerequisite: Python
  • Recommended installation: via Python pip
  • Some legacy installation methods
• Getting started
  • Example notebooks (.ipynb)
  • On demand examples from online Atom calculator
  • Frequently asked questions (FAQ)
• Detailed API documentation
  • Algebra, numerics and IO
  • Alkali atom functions
  • Alkali atom data
  • Divalent atom functions
  • Divalent atom data
  • Single atom calculations
  • Pair-state basis calculations
  • Advanced functions
• How to contribute
  • Ideas for development
  • Before you start
  • Naming conventions

Note

ARC 3.0 added support for divalent atoms and some of the functions (Wavefunction, AtomSurfaceVdW, OpticalLattice1D, DynamicPolarizability, and optical materials properties). See more at 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

Package structure

Overview of modules and interdependencies in the arc package. Click on image to enlarge.

Indices and tables

• Index

• Module Index

• Search Page

Credits

Authors

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

Cite as

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 or new features introduced in 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, if you use arc_advanced extensions check arc.advanced .

Licence

BSD 3-Clause

Version

3.0.0 of 2020/07/27