rydiqule.atom_utils

Utilities for interacting with atomic parameters and ARC.

Module Attributes

ATOMS

Alkali atoms defined by ARC that can be used with Cell.

Functions

D1_excited(n[, splitting, expand])	Retrieve A_QState of the excited state of the D1 line of an atom or principle quantum number.
D1_states(n[, splitting, g_splitting, ...])	Return the ground and excited states for the D1 line of a rydberg atom.
D2_excited(n[, splitting, expand])	Retrieve A_QState of the excited state of the D2 line of an atom or principle quantum number.
D2_states(n[, splitting, g_splitting, ...])	Return the ground and excited states for the D1 line of a rydberg atom.
calc_eta(omega, dipole_moment, beam_area)	Calculates the eta constant needed from some experiment calculations
calc_kappa(omega, dipole_moment, density)	Calculates the kappa constant needed for observable calculations.
expand_qnums(qstates[, I])	Expand all list-like A_QStates in a list.
expand_single_qnum(qstate[, I, wildcard])	Generates a list of all valid states given a particular quantum number to be expanded.
get_valid_f(state[, I])	Return the valid values of f for given other quantum numbers.
get_valid_j(state[, I])	Return the valid values of j for given other quantum numbers.
get_valid_mf(state[, I])	Return the valid values of m_f for given other quantum numbers.
get_valid_mj(state[, I])	Return the valid values of m_J for given other quantum numbers.
ground_state(n[, splitting, expand])	Retrieve A_QState for the ground state of an atom or principle quantum number.
match_A_QState(qstate[, compare_list, I])	Function to return all states in a list matching the provided pattern.
validate_qnums(qstate[, I])	Validate that the provided named_tuple is a valid rydberg atomic state

Classes

A_QState(n, l, j[, m_j, f, m_f])	Named tuple class designed to represent the quantum numbers a state spec of an alkali atom.
QState(n, l, j[, m_j, f, m_f])	Named tuple class designed to represent the quantum numbers in the state of an alkali atom.