Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve #166

Merged
merged 1 commit into from
Feb 21, 2025
Merged

docs: improve #166

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions src/elisa/models/add.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ class Band(NumIntAdditive):
&\text{otherwise,}
\end{cases}

where :math:`E_0` is the pivot energy fixed at 100 keV.
where :math:`E_0` is the reference energy fixed at 100 keV.

Parameters
----------
Expand Down Expand Up @@ -139,7 +139,7 @@ class BandEp(NumIntAdditive):
&\text{otherwise},
\end{cases}

where :math:`E_0` is the pivot energy fixed at 100 keV.
where :math:`E_0` is the reference energy fixed at 100 keV.

.. warning::
This model requires the low-energy power law index :math:`\alpha`
Expand Down Expand Up @@ -408,7 +408,7 @@ class CutoffPL(NumIntAdditive):
N(E) = K \left(\frac{E}{E_0}\right)^{-\alpha}
\exp \left(-\frac{E}{E_\mathrm{c}}\right),

where :math:`E_0` is the pivot energy fixed at 1 keV.
where :math:`E_0` is the reference energy fixed at 1 keV.

Parameters
----------
Expand Down Expand Up @@ -447,7 +447,7 @@ class Compt(NumIntAdditive):
N(E) = K \left(\frac{E}{E_0}\right)^{-\alpha}
\exp \left[-\frac{(2-\alpha)E}{E_\mathrm{p}}\right],

where :math:`E_0` is the pivot energy fixed at 1 keV.
where :math:`E_0` is the reference energy fixed at 1 keV.

Parameters
----------
Expand Down Expand Up @@ -568,7 +568,7 @@ class OTTB(NumIntAdditive):
N(E) = K \left(\frac{E}{E_0}\right)^{-1} \exp\left(-\frac{E}{kT}\right)
\exp\left(\frac{E_0}{kT}\right),

where :math:`E_0` is the pivot energy fixed at 1 keV.
where :math:`E_0` is the reference energy fixed at 1 keV.

Parameters
----------
Expand Down Expand Up @@ -635,7 +635,7 @@ class PowerLaw(AnaIntAdditive):
.. math::
N(E) = K \left(\frac{E}{E_0}\right)^{-\alpha},

where :math:`E_0` is the pivot energy fixed at 1 keV.
where :math:`E_0` is the reference energy fixed at 1 keV.

Parameters
----------
Expand Down Expand Up @@ -727,7 +727,7 @@ class PLPhFlux(PLFluxNorm):
\right]^{-1}
\left(\frac{E}{E_0}\right)^{-\alpha},

where :math:`E_0` is the pivot energy fixed at 1 keV.
where :math:`E_0` is the reference energy fixed at 1 keV.

Parameters
----------
Expand Down Expand Up @@ -771,7 +771,7 @@ class PLEnFlux(PLFluxNorm):
\right]^{-1}
\left(\frac{E}{E_0}\right)^{-\alpha},

where :math:`E_0` is the pivot energy fixed at 1 keV.
where :math:`E_0` is the reference energy fixed at 1 keV.

Parameters
----------
Expand Down Expand Up @@ -815,7 +815,7 @@ class SmoothlyBrokenPL(NumIntAdditive):
\right]
\right\}^{-\rho},

where :math:`E_0` is the pivot energy fixed at 1 keV.
where :math:`E_0` is the reference energy fixed at 1 keV.

Parameters
----------
Expand Down