Various fixes

docs/api_reference.rst

@@ -0,0 +1,76 @@
+API Reference
+=============
+
+
+The RydState python API can be accessed via the ``rydstate`` module by
+
+.. code-block:: python
+
+    import rydstate
+
+
+All the available classes, methods and functions are documented below:
+
+.. currentmodule:: rydstate
+
+**Rydberg States**
+
+.. autosummary::
+    :toctree: _autosummary/
+
+       RydbergStateSQDT
+       RydbergStateSQDTAlkali
+       RydbergStateSQDTAlkalineLS
+       RydbergStateSQDTAlkalineJJ
+       RydbergStateSQDTAlkalineFJ
+
+**Rydberg Basis**
+
+.. autosummary::
+    :toctree: _autosummary/
+
+       BasisSQDTAlkali
+       BasisSQDTAlkalineLS
+       BasisSQDTAlkalineJJ
+       BasisSQDTAlkalineFJ
+
+**Angular module**
+
+.. autosummary::
+    :toctree: _autosummary/
+
+       angular.AngularKetLS
+       angular.AngularKetJJ
+       angular.AngularKetFJ
+       angular.AngularState
+       angular.utils
+
+
+**Radial module**
+
+.. autosummary::
+    :toctree: _autosummary/
+
+       radial.RadialKet
+       radial.Wavefunction
+       radial.Model
+       radial.numerov
+
+**Species module and parameters**
+
+.. autosummary::
+    :toctree: _autosummary/
+
+       species.SpeciesObject
+       species.HydrogenTextBook
+       species.Hydrogen
+       species.Lithium
+       species.Sodium
+       species.Potassium
+       species.Rubidium
+       species.Cesium
+       species.Strontium87
+       species.Strontium88
+       species.Ytterbium171
+       species.Ytterbium173
+       species.Ytterbium174

docs/index.rst

@@ -9,11 +9,4 @@
     :hidden:
 
     examples.rst
-
-
-.. toctree::
-    :maxdepth: 2
-    :caption: References
-    :hidden:
-
-    modules.rst
+    api_reference.rst

src/rydstate/__init__.py

@@ -1,5 +1,10 @@
-from rydstate import angular, radial, species
-from rydstate.basis import BasisSQDTAlkali, BasisSQDTAlkalineFJ, BasisSQDTAlkalineJJ, BasisSQDTAlkalineLS
+from rydstate import angular, basis, radial, rydberg, species
+from rydstate.basis import (
+    BasisSQDTAlkali,
+    BasisSQDTAlkalineFJ,
+    BasisSQDTAlkalineJJ,
+    BasisSQDTAlkalineLS,
+)
 from rydstate.rydberg import (
     RydbergStateSQDT,
     RydbergStateSQDTAlkali,
@@ -20,7 +25,9 @@
     "RydbergStateSQDTAlkalineJJ",
     "RydbergStateSQDTAlkalineLS",
     "angular",
+    "basis",
     "radial",
+    "rydberg",
     "species",
     "ureg",
 ]

src/rydstate/angular/__init__.py

@@ -1,3 +1,4 @@
+from rydstate.angular import utils
 from rydstate.angular.angular_ket import AngularKetFJ, AngularKetJJ, AngularKetLS
 from rydstate.angular.angular_state import AngularState
 
@@ -6,4 +7,5 @@
     "AngularKetJJ",
     "AngularKetLS",
     "AngularState",
+    "utils",
 ]

src/rydstate/angular/angular_ket.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import contextlib
 import logging
 from abc import ABC
 from typing import TYPE_CHECKING, Any, ClassVar, Literal, overload
@@ -13,14 +14,12 @@
     is_angular_operator_type,
 )
 from rydstate.angular.utils import (
-    calc_wigner_3j,
     check_spin_addition_rule,
-    clebsch_gordan_6j,
-    clebsch_gordan_9j,
     get_possible_quantum_number_values,
     minus_one_pow,
     try_trivial_spin_addition,
 )
+from rydstate.angular.wigner_symbols import calc_wigner_3j, clebsch_gordan_6j, clebsch_gordan_9j
 from rydstate.species import SpeciesObject
 
 if TYPE_CHECKING:
@@ -773,15 +772,17 @@ def quantum_numbers_to_angular_ket(
           Optional, only needed for concrete angular matrix elements.
 
     """
-    if all(qn is None for qn in [j_c, f_c, j_r]):
+    with contextlib.suppress(InvalidQuantumNumbersError, ValueError):
         return AngularKetLS(
             s_c=s_c, l_c=l_c, s_r=s_r, l_r=l_r, s_tot=s_tot, l_tot=l_tot, j_tot=j_tot, f_tot=f_tot, m=m, species=species
         )
-    if all(qn is None for qn in [s_tot, l_tot, f_c]):
+
+    with contextlib.suppress(InvalidQuantumNumbersError, ValueError):
         return AngularKetJJ(
             s_c=s_c, l_c=l_c, j_c=j_c, s_r=s_r, l_r=l_r, j_r=j_r, j_tot=j_tot, f_tot=f_tot, m=m, species=species
         )
-    if all(qn is None for qn in [s_tot, l_tot, j_tot]):
+
+    with contextlib.suppress(InvalidQuantumNumbersError, ValueError):
         return AngularKetFJ(
             s_c=s_c, l_c=l_c, j_c=j_c, f_c=f_c, s_r=s_r, l_r=l_r, j_r=j_r, f_tot=f_tot, m=m, species=species
         )

src/rydstate/angular/angular_matrix_element.py

@@ -7,7 +7,8 @@
 import numpy as np
 from typing_extensions import TypeGuard
 
-from rydstate.angular.utils import calc_wigner_3j, calc_wigner_6j, minus_one_pow
+from rydstate.angular.utils import minus_one_pow
+from rydstate.angular.wigner_symbols import calc_wigner_3j, calc_wigner_6j
 
 if TYPE_CHECKING:
     from typing_extensions import ParamSpec