nikolasibalic / ARC-Alkali-Rydberg-Calculator

Object-oriented Python library for computation of properties of highly-excited Rydbeg states of alkali and divalent atoms.
https://atomcalc.org
BSD 3-Clause "New" or "Revised" License
90 stars 78 forks source link

Clarification of documentation in getBranchingRatio #120

Closed jxm083 closed 2 years ago

jxm083 commented 2 years ago

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$

nikolasibalic commented 2 years ago

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