Skip to content

Commit

Permalink
doc files for cigale modules
Browse files Browse the repository at this point in the history
  • Loading branch information
Wilfried (Mac) committed Dec 19, 2023
1 parent 08bd68a commit a900193
Show file tree
Hide file tree
Showing 7 changed files with 287 additions and 0 deletions.
60 changes: 60 additions & 0 deletions source/API/misc/cigaleModules/SFH.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
Star formation histories
========================

.. tab-set::

.. tab-item:: Base class

.. autoclass:: pixSED.misc.cigaleModules.SFHmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Two exponential

.. autoclass:: pixSED.misc.cigaleModules.SFH2EXPmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Delayed

.. autoclass:: pixSED.misc.cigaleModules.SFHDELAYEDmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Delayed BQ

.. autoclass:: pixSED.misc.cigaleModules.SFHDELAYEDBQmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: From file

.. autoclass:: pixSED.misc.cigaleModules.SFHFROMFILEmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Periodic

.. autoclass:: pixSED.misc.cigaleModules.SFHPERIODICmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Buat

.. autoclass:: pixSED.misc.cigaleModules.SFH_BUATmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:
20 changes: 20 additions & 0 deletions source/API/misc/cigaleModules/SFH_quench.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Star formation history quenching modules
========================================

.. tab-set::

.. tab-item:: Smooth quenching

.. autoclass:: pixSED.misc.cigaleModules.SFH_QUENCHING_SMOOTHmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Truncated quenching

.. autoclass:: pixSED.misc.cigaleModules.SFH_QUENCHING_TRUNKmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:
27 changes: 27 additions & 0 deletions source/API/misc/cigaleModules/SSP.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Single stellar populations
==========================
.. tab-set::

.. tab-item:: Base class

.. autoclass:: pixSED.misc.cigaleModules.SSPmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Bruzual & Charlot (2003)

.. autoclass:: pixSED.misc.cigaleModules.BC03module
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Maraston et al. (2005)

.. autoclass:: pixSED.misc.cigaleModules.M2005module
:special-members: __str__
:members:
:private-members:
:show-inheritance:
52 changes: 52 additions & 0 deletions source/API/misc/cigaleModules/dust_attenuation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
Dust attenuation
================

.. tab-set::

.. tab-item:: Base class

.. autoclass:: pixSED.misc.cigaleModules.ATTENUATIONmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Powerlaw

.. autoclass:: pixSED.misc.cigaleModules.DUSTATT_POWERLAWmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Two powerlaws

.. autoclass:: pixSED.misc.cigaleModules.DUSTATT_2POWERLAWSmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Calzetti et al. (2000)

.. autoclass:: pixSED.misc.cigaleModules.DUSTATT_CALZLETTImodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Charlot & Fall (2000)

.. autoclass:: pixSED.misc.cigaleModules.DUSTATT_MODIFIED_CF00module
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Starburst

.. autoclass:: pixSED.misc.cigaleModules.DUSTATT_MODIFIED_STARBURSTmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:
68 changes: 68 additions & 0 deletions source/API/misc/cigaleModules/dust_emission.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
Dust emission
=============

.. tab-set::

.. tab-item:: Base class

.. autoclass:: pixSED.misc.cigaleModules.DUSTmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Modified black body

.. autoclass:: pixSED.misc.cigaleModules.MBBmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Schreiber et al. (2016)

.. autoclass:: pixSED.misc.cigaleModules.SCHREIBERmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Casey et al. (2012)

.. autoclass:: pixSED.misc.cigaleModules.CASEYmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Dale et al. (2014)

.. autoclass:: pixSED.misc.cigaleModules.DALEmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Draine & Li (2007)

.. autoclass:: pixSED.misc.cigaleModules.DL07module
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Draine et al. (2014)

.. autoclass:: pixSED.misc.cigaleModules.DL14module
:special-members: __str__
:members:
:private-members:
:show-inheritance:

.. tab-item:: Themis

.. autoclass:: pixSED.misc.cigaleModules.THEMISmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:
52 changes: 52 additions & 0 deletions source/API/misc/cigaleModules/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
Modules for Cigale_
===================

.. toctree::
:hidden:

SFH
SFH_quench
SSP
nebular
dust_attenuation
dust_emission

.. grid:: 2

.. grid-item::

.. card:: Star formation histories
:link: SFH
:link-type: doc

Documentation related to :py:class:`~pixSED.misc.cigaleModules.SFHmodule` class and sub-classes.

.. card:: Star formation history quenching modules
:link: SFH_quench
:link-type: doc

Documentation related to specific syb-classes of :py:class:`~pixSED.misc.cigaleModules.SSPmodule` that quench star-formation in other modules.

.. card:: Single stellar populations
:link: SSP
:link-type: doc

Documentation related to :py:class:`~pixSED.misc.cigaleModules.SSPmodule` class and sub-classes.

.. card:: Nebular emission
:link: nebular
:link-type: doc

Documentation related to :py:class:`~pixSED.misc.cigaleModules.NEBULARmodule` class.

.. card:: Dust attenuation
:link: dust_attenuation
:link-type: doc

Documentation related to :py:class:`~pixSED.misc.cigaleModules.ATTENUATIONmodule` class and sub-classes.

.. card:: Dust emission
:link: dust_emission
:link-type: doc

Documentation related to :py:class:`~pixSED.misc.cigaleModules.DUSTmodule` class and sub-classes.
8 changes: 8 additions & 0 deletions source/API/misc/cigaleModules/nebular.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Nebular emission
================

.. autoclass:: pixSED.misc.cigaleModules.NEBULARmodule
:special-members: __str__
:members:
:private-members:
:show-inheritance:

0 comments on commit a900193

Please sign in to comment.