ARC documentation

ARC (Alkali 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 atoms.

Contents

• Installation instructions
  • Prerequisite: Python
  • Download the ARC library/package
  • Compiling C extension
• Getting started with ARC
  • IPython notebook with examples
  • On demand examples from online Atom calculator
  • Frequently asked questions (FAQ)
• Detailed documentation of functions
  • Alkali atom functions
  • Alkali atom data
  • Single atom calculations
  • Pair-state basis calculations
• How to contribute to the project
  • Ideas for development
  • Naming conventions

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ć, Jonathan D. Pritchard, Charles S. Adams, Kevin J. Weatherill Licence:BSD 3-Clause Version:0.9.1 of 2017/03/10