0.12.1

radis · Apr 13, 2022 · 1cc969e · 1cc969e
2 parents e75694a + 4b506f7
commit 1cc969e
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 24 deletions.
diff --git a/README.rst b/README.rst
@@ -13,8 +13,6 @@ with RADIS or other spectral codes.
 
 User guide, install procedure and examples are available on the `RADIS Website <http://radis.readthedocs.io/>`__:
 
-|badge_docs|
-
 
 ===============
 Getting Started
@@ -274,7 +272,7 @@ See `awesome-spectra <https://github.com/erwanp/awesome-spectra>`__   |badge_awe
 .. |CO2| replace:: CO\ :sub:`2`
 
 .. |badge_docs| image:: https://readthedocs.org/projects/radis/badge/
-                :target: https://radis.readthedocs.io/en/latest/?badge=latest
+                :target: https://readthedocs.org/projects/radis/
                 :alt: Documentation Status
 
 .. |badge_article1| image:: https://zenodo.org/badge/doi/10.1016/j.jqsrt.2018.09.027.svg

diff --git a/docs/conf.py b/docs/conf.py
@@ -140,15 +140,19 @@ def setup(app):
 
 # Reference other packages
 intersphinx_mapping = {
-    "joblib": ("https://joblib.readthedocs.io/en/latest/", None),
+    "astropy": ("https://docs.astropy.org/en/stable/", None),
     "astroquery": ("https://astroquery.readthedocs.io/en/latest/", None),
+    "cantera": ("https://www.cantera.org/documentation/docs-2.4/sphinx/html/", None),
+    "fitroom": ("https://fitroom.readthedocs.io/en/latest/", None),
+    "habanero": ("https://habanero.readthedocs.io/en/latest/", None),
+    "joblib": ("https://joblib.readthedocs.io/en/latest/", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
     "matplotlib": ("https://matplotlib.org/stable/", None),
     "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
     "pytexit": ("https://pytexit.readthedocs.io/en/latest/", None),
     "scipy": ("https://docs.scipy.org/doc/scipy/", None),
     "seaborn": ("https://seaborn.pydata.org/", None),
-    "fitroom": ("https://fitroom.readthedocs.io/en/latest/", None),
+    "specutils": ("https://specutils.readthedocs.io/en/stable/", None),
 }
 
 napoleon_google_docstring = False

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,5 @@
+Cython
+numpy
 sphinx-autodoc-annotation
 sphinx_autodoc_defaultargs>=0.1.2
 sphinx>=1.7.0

diff --git a/radis/lbl/base.py b/radis/lbl/base.py
@@ -3077,34 +3077,36 @@ def calc_linestrength_noneq(self):
 
     # %%
     def calc_emission_integral(self):
-        r"""Calculate Emission Integral.
+        r"""Calculate the emission integral (in :math:`mW/sr`) of all lines in DataFrame ``df1``.
 
         .. math::
-            Ei=\frac{n_u A_{ul}}{4} \pi \Delta E_{ul}
 
-        Emission Integral is a non usual quantity introduced here to have an
-        equivalent of Linestrength in emission calculation
+            E_i=\frac{n_u A_{ul}}{4 \pi} \Delta E_{ul}
 
-        Returns
-        -------
-        None
-            Emission integral `Ei` added in self.df
+        Where :math:`A_{ul}` (:math:`s^{-1}`) is the Einstein coefficient of the corresponding line,
+        :math:`n_u` (in :math:`cm^{-3}/cm^{-3}` is the fraction of the molecule population in the upper rovibrational state,
+        and :math:`\Delta E_{ul}` the transition energy.
 
-        Notes
-        -----
+        Emission Integral is a non usual quantity introduced in RADIS as an
+        equivalent for emission calculations of the Linestrength quantity used in absorption calculations.
+
+        The emission integral is later multiplied by the total density :math:`n_tot` and the lineshape :math:`\Phi_i` to obtain
+        the spectral emission coefficient :math:`\epsilon_i` associated to each line.
 
-        emission_integral: (mW/sr)
-            emission integral is defined as::
+        .. math::
 
-            Ei = n_u * A_ul / 4π * DeltaE_ul
-                  :      :     :      :
-                (#/#)  (s-1) (sr)    (mJ)
+            \epsilon_i(\lambda) = E_i \cdot n_{tot} \cdot \Phi_i(\lambda)
 
-            So that the radiance ϵ is:
+        Which are afterwards summed over all N lines to obtain the total emission coefficient :
 
-                ϵ(λ)   =      Ei  *   Phi(λ)  * ntot   * path_length
-                 :             :         :       :          :
-            mW/cm2/sr/nm    (mW/sr)   (1/nm)   (cm-3)      (cm)
+        .. math::
+
+            \epsilon(\lambda) = \sum_i^N {\epsilon_i}(\lambda)
+
+        Returns
+        -------
+        None
+            Emission integral `Ei` added in ``df1``
 
         See Also
         --------