Skip to content

Commit

Permalink
Adds docs for various similar level columns
Browse files Browse the repository at this point in the history
Also moved notation to a more accessible spot.
  • Loading branch information
andrewfullard committed Sep 10, 2024
1 parent 09bd62c commit f9eb0d4
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 7 deletions.
15 changes: 8 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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 <https://gitter.im/tardis-sn/carsus/>`_.
24 changes: 24 additions & 0 deletions docs/reference/level_index_id_number.rst
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.

0 comments on commit f9eb0d4

Please sign in to comment.