Add docs

AlexHls · Nov 1, 2023 · d62ccfd · d62ccfd
1 parent 44fe04a
commit d62ccfd
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/docs/io/configuration/components/plasma.rst b/docs/io/configuration/components/plasma.rst
@@ -44,4 +44,15 @@ NLTE
 The NLTE configuration currently allows setting ``coronal_approximation``, which sets all :math:`J_\textrm{blue}` to 0.
 This is useful for debugging with :term:`chianti` for example. Furthermore, one can enable 'classical_nebular' to set all
 :math:`\beta_\textrm{Sobolev}` to 1. Both options are used for checking with other codes and should not be enabled in
-normal operations.
+normal operations.
+
+NLTE Ionization
+^^^^^^^^^^^^^^^
+
+.. code-block:: yaml
+
+    plasma:
+        nlte_ionization_species: [H I, H II, He I, He II]
+    
+This option allows the user to specify which species should be included in the NLTE ionization treatment. Note that the
+species must be present in the continuum interaction species as well.
diff --git a/docs/physics/setup/plasma/index.rst b/docs/physics/setup/plasma/index.rst
@@ -73,6 +73,9 @@ The next more complex class is `LTEPlasma` which will calculate the ionization b
 
 TARDIS also allows for NLTE treatments of specified species, as well as special NLTE treatments for Helium.
 
+.. note::
+    The NLTE treatment of specified species is currently incompatible with the NLTE treatment for helium and cannot be used simulataneously.
+
 .. toctree::
     :maxdepth: 2