From f9eb0d46db5b0e344e9def769036ab21abd09ef6 Mon Sep 17 00:00:00 2001 From: Andrew Fullard Date: Tue, 10 Sep 2024 14:53:08 -0400 Subject: [PATCH] Adds docs for various similar level columns Also moved notation to a more accessible spot. --- docs/index.rst | 15 ++++++------ docs/reference/level_index_id_number.rst | 24 ++++++++++++++++++++ docs/{development => reference}/notation.rst | 0 3 files changed, 32 insertions(+), 7 deletions(-) create mode 100644 docs/reference/level_index_id_number.rst rename docs/{development => reference}/notation.rst (100%) diff --git a/docs/index.rst b/docs/index.rst index 68a9ca1dc..6f1e06cc6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,7 @@ Carsus is a package to manage atomic datasets. It can read data from a variety o installation.rst quickstart development/compare_atomic_files + reference/notation.rst .. toctree:: :maxdepth: 2 @@ -26,6 +27,13 @@ Carsus is a package to manage atomic datasets. It can read data from a variety o io/vald io/barklem2016 +.. toctree:: + :maxdepth: 2 + :caption: Reference + :hidden: + reference/notation.rst + reference/level_index_id_number.rst + .. toctree:: :maxdepth: 2 :caption: Research with Carsus @@ -50,13 +58,6 @@ Carsus is a package to manage atomic datasets. It can read data from a variety o api/modules -.. toctree:: - :maxdepth: 2 - :caption: Legacy Code - :hidden: - - legacy/index.rst - .. seealso:: Need help? Contact us `on Gitter `_. diff --git a/docs/reference/level_index_id_number.rst b/docs/reference/level_index_id_number.rst new file mode 100644 index 000000000..4f38f0d00 --- /dev/null +++ b/docs/reference/level_index_id_number.rst @@ -0,0 +1,24 @@ +*************** +Differences between level_index, level_id and level_number +*************** + +============= +level_index +============= + +DataFrame index for each electronic energy level. Different for every level. +Third index for energy levels after atomic number and ion charge. + +============= +level_id +============= + +Global cross-matching ID for levels across multiple DataFrames i.e. between photo +ionization cross sections, the macro atom and electronic energy levels. + +============= +level_number +============= + +DataFrame index for each level suitable for TARDIS use. Connects upper and lower +energy levels. \ No newline at end of file diff --git a/docs/development/notation.rst b/docs/reference/notation.rst similarity index 100% rename from docs/development/notation.rst rename to docs/reference/notation.rst