nikolasibalic/ARC-Alkali-Rydberg-Calculator

Clarification of documentation in getBranchingRatio

jxm083 opened this issue · 1 comments

In the documentation for AlkaliAtom.getBranchingRatio (possibly other implementations of getBranchingRatio as well) the expression for the branching ratio is expressed in terms of the hyperfine reduced dipole matrix element, suggesting the quantity has units of [C][m].

A comment in the source code clarifies that it is expressed in units of the fine reduced diple matrix element, making the quantity unitless, as expected.

Could this be added to the function documentation? changing $|\langle j_e, f_e||er||j_g,f_g\rangle|^2$ to $|\langle j_e, f_e||er||j_g,f_g\rangle|^2/|\langle j_e || er || j_g \rangle |^2$

Thank you for your contribution @jxm083 !
This has been fixed now in documentation.