updated the documentation with the new version

WilfriedMercier · Dec 19, 2023 · 91bd1b0 · 91bd1b0
1 parent cbe629d
commit 91bd1b0
Show file tree

Hide file tree

Showing 189 changed files with 33,396 additions and 15,856 deletions.
diff --git a/docs/API/catalogues.html b/docs/API/catalogues.html
diff --git a/docs/API/filters.html b/docs/API/filters.html
diff --git a/docs/API/index.html b/docs/API/index.html
diff --git a/docs/API/misc/cigaleModules/SFH.html b/docs/API/misc/cigaleModules/SFH.html
diff --git a/docs/API/misc/cigaleModules/SFH_quench.html b/docs/API/misc/cigaleModules/SFH_quench.html
diff --git a/docs/API/misc/cigaleModules/SSP.html b/docs/API/misc/cigaleModules/SSP.html
diff --git a/docs/API/misc/cigaleModules/dust_attenuation.html b/docs/API/misc/cigaleModules/dust_attenuation.html
diff --git a/docs/API/misc/cigaleModules/dust_emission.html b/docs/API/misc/cigaleModules/dust_emission.html
diff --git a/docs/API/misc/cigaleModules/index.html b/docs/API/misc/cigaleModules/index.html
diff --git a/docs/API/misc/cigaleModules/nebular.html b/docs/API/misc/cigaleModules/nebular.html
diff --git a/docs/API/misc/enum.html b/docs/API/misc/enum.html
diff --git a/docs/API/misc/index.html b/docs/API/misc/index.html
diff --git a/docs/API/misc/misc.html b/docs/API/misc/misc.html
diff --git a/docs/API/misc/properties.html b/docs/API/misc/properties.html
diff --git a/docs/API/outputs.html b/docs/API/outputs.html
diff --git a/docs/API/photometry.html b/docs/API/photometry.html
diff --git a/docs/API/sed.html b/docs/API/sed.html
diff --git a/docs/_images/example1-1.png b/docs/_images/example1-1.png
diff --git a/docs/_images/example2-1.png b/docs/_images/example2-1.png
diff --git a/docs/_images/example3-1.png b/docs/_images/example3-1.png
diff --git a/docs/_images/examples_0_1.png b/docs/_images/examples_0_1.png
diff --git a/docs/_images/examples_1_1.png b/docs/_images/examples_1_1.png
diff --git a/docs/_images/examples_2_1.png b/docs/_images/examples_2_1.png
diff --git a/docs/_images/index_0_1.png b/docs/_images/index_0_1.png
diff --git a/docs/_images/math/027d0fd23daa8ff572de23e43c20678147b037a5.png b/docs/_images/math/027d0fd23daa8ff572de23e43c20678147b037a5.png
diff --git a/docs/_images/math/06573ea902cc42fd29eb0efddf78a5d6237c028f.png b/docs/_images/math/06573ea902cc42fd29eb0efddf78a5d6237c028f.png
diff --git a/docs/_images/math/07292f283c92d1df75423cae4f34ccd4e465de99.png b/docs/_images/math/07292f283c92d1df75423cae4f34ccd4e465de99.png
diff --git a/docs/_images/math/2acf0fa7b34a1a3cdf10c733add0353c8aca16c7.png b/docs/_images/math/2acf0fa7b34a1a3cdf10c733add0353c8aca16c7.png
diff --git a/docs/_images/math/2f5aa019312e1bbc969deab8dca8b00f76025404.png b/docs/_images/math/2f5aa019312e1bbc969deab8dca8b00f76025404.png
diff --git a/docs/_images/math/81b6f0c96a4f0a609bee021ad0d6254487b9f968.png b/docs/_images/math/81b6f0c96a4f0a609bee021ad0d6254487b9f968.png
diff --git a/docs/_images/math/a5042e08739088fc054196a4c99b26d9af703d31.png b/docs/_images/math/a5042e08739088fc054196a4c99b26d9af703d31.png
diff --git a/docs/_images/math/df00656702b70b4b6f7ffbf6a9aa9a334bab1914.png b/docs/_images/math/df00656702b70b4b6f7ffbf6a9aa9a334bab1914.png
diff --git a/docs/_modules/SED/catalogues.html b/docs/_modules/SED/catalogues.html
diff --git a/docs/_modules/SED/filters.html b/docs/_modules/SED/filters.html
diff --git a/docs/_modules/SED/misc/enum.html b/docs/_modules/SED/misc/enum.html
diff --git a/docs/_modules/SED/misc/misc.html b/docs/_modules/SED/misc/misc.html
diff --git a/docs/_modules/SED/photometry.html b/docs/_modules/SED/photometry.html
diff --git a/docs/_modules/functools.html b/docs/_modules/functools.html
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
diff --git a/docs/_modules/pixSED/catalogues.html b/docs/_modules/pixSED/catalogues.html
diff --git a/docs/_modules/pixSED/filters.html b/docs/_modules/pixSED/filters.html
diff --git a/docs/_modules/pixSED/misc/cigaleModules.html b/docs/_modules/pixSED/misc/cigaleModules.html
diff --git a/docs/_modules/pixSED/misc/enum.html b/docs/_modules/pixSED/misc/enum.html
diff --git a/docs/_modules/pixSED/misc/misc.html b/docs/_modules/pixSED/misc/misc.html
diff --git a/docs/_modules/SED/misc/properties.html → docs/_modules/pixSED/misc/properties.html b/docs/_modules/SED/misc/properties.html → docs/_modules/pixSED/misc/properties.html
diff --git a/docs/_modules/SED/outputs.html → docs/_modules/pixSED/outputs.html b/docs/_modules/SED/outputs.html → docs/_modules/pixSED/outputs.html
diff --git a/docs/_modules/pixSED/photometry.html b/docs/_modules/pixSED/photometry.html
diff --git a/docs/_modules/SED/sed.html → docs/_modules/pixSED/sed.html b/docs/_modules/SED/sed.html → docs/_modules/pixSED/sed.html
diff --git a/docs/_sources/API/catalogues.rst.txt b/docs/_sources/API/catalogues.rst.txt
@@ -3,7 +3,7 @@ Catalogue classes
 
 .. _Table.write(): https://docs.astropy.org/en/stable/api/astropy.table.Table.html#astropy.table.Table.write
 
-.. automodule:: SED.catalogues
+.. automodule:: pixSED.catalogues
     :members:
     :private-members:
     :show-inheritance:
diff --git a/docs/_sources/API/filters.rst.txt b/docs/_sources/API/filters.rst.txt
@@ -1,7 +1,7 @@
 Filter classes
 ==============
 
-.. automodule:: SED.filters
+.. automodule:: pixSED.filters
     :members:
     :private-members:
     :show-inheritance:
diff --git a/docs/_sources/API/index.rst.txt b/docs/_sources/API/index.rst.txt
@@ -2,10 +2,63 @@ API
 ===
 
 .. toctree::
+    :hidden:
 
     catalogues
     filters
     misc/index
     outputs
     photometry
     sed
+
+.. grid:: 2
+
+    .. grid-item::
+
+        .. card:: Catalogues
+            :link: catalogues
+            :link-type: doc
+
+            Documentation related to :py:class:`~.Catalogue` class and sub-classes.
+
+    .. grid-item::
+
+        .. card:: Filters
+            :link: filters
+            :link-type: doc
+
+            Documentation related to :py:class:`~.Filter` and :py:class:`~.FilterList` classes.
+
+    .. grid-item::
+
+        .. card:: Miscellaneous
+            :link: misc/index
+            :link-type: doc
+
+            Documentation related to various misc module.
+
+    .. grid-item::
+
+        .. card:: Outputs
+            :link: outputs
+            :link-type: doc
+
+            Documentation related to :py:class:`~.Output` class and sub-classes.
+
+    .. grid-item::
+
+        .. card:: Photometry
+            :link: photometry
+            :link-type: doc
+
+            Documentation related to various functions related to photometric conversions defined in :py:mod:`~pixSED.photometry`.
+
+    .. grid-item::
+
+        .. card:: Sed objects
+            :link: sed
+            :link-type: doc
+
+            Documentation related to :py:class:`~.SED` class and sub-classes.
+
+
diff --git a/docs/_sources/API/misc/cigaleModules/SFH.rst.txt b/docs/_sources/API/misc/cigaleModules/SFH.rst.txt
@@ -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:
diff --git a/docs/_sources/API/misc/cigaleModules/SFH_quench.rst.txt b/docs/_sources/API/misc/cigaleModules/SFH_quench.rst.txt
@@ -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:
diff --git a/docs/_sources/API/misc/cigaleModules/SSP.rst.txt b/docs/_sources/API/misc/cigaleModules/SSP.rst.txt
@@ -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:
diff --git a/docs/_sources/API/misc/cigaleModules/dust_attenuation.rst.txt b/docs/_sources/API/misc/cigaleModules/dust_attenuation.rst.txt
@@ -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:
diff --git a/docs/_sources/API/misc/cigaleModules/dust_emission.rst.txt b/docs/_sources/API/misc/cigaleModules/dust_emission.rst.txt
@@ -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:
diff --git a/docs/_sources/API/misc/cigaleModules/index.rst.txt b/docs/_sources/API/misc/cigaleModules/index.rst.txt
@@ -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.
diff --git a/docs/_sources/API/misc/cigaleModules/nebular.rst.txt b/docs/_sources/API/misc/cigaleModules/nebular.rst.txt
@@ -0,0 +1,8 @@
+Nebular emission
+================
+
+.. autoclass:: pixSED.misc.cigaleModules.NEBULARmodule
+    :special-members: __str__
+    :members:
+    :private-members:
+    :show-inheritance:
diff --git a/docs/_sources/API/misc/enum.rst.txt b/docs/_sources/API/misc/enum.rst.txt
@@ -1,7 +1,7 @@
 Enumeration classes
 ===================
 
-.. automodule:: SED.misc.enum
+.. automodule:: pixSED.misc.enum
     :special-members: __str__
     :members:
     :private-members: