Skip to content

Commit

Permalink
added clarification in documentation ( #61 )
Browse files Browse the repository at this point in the history
  • Loading branch information
nikolasibalic committed May 11, 2021
1 parent 2977f3c commit e5d558a
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions arc/alkali_atom_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -654,9 +654,13 @@ def getEnergy(self, n, l, j, s=0.5):
program will try use NIST energy value, if such exists,
falling back to energy calculation with quantum defects if
the measured value doesn't exist. For `preferQuantumDefects` =True,
program will always calculate energies from quantum defects
program will calculate energies from quantum defects
(useful for comparing quantum defect calculations with measured
energy level values).
energy level values) if the principal quantum number of the
requested state is larger than the minimal quantum principal quantum
number `self.minQuantumDefectN` which sets minimal quantum number
for which quantum defects still give good estimate of state energy
(below this value saved energies will be used if existing).
Args:
n (int): principal quantum number
Expand Down

0 comments on commit e5d558a

Please sign in to comment.