Skip to content

Commit

Permalink
Minor update in documation and README
Browse files Browse the repository at this point in the history
  • Loading branch information
tomasstolker committed Feb 1, 2024
1 parent 5a1f4cf commit 1e7cd67
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 19 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

*species* is a toolkit for atmospheric characterization of directly imaged exoplanets. It provides a coherent framework for spectral and photometric analysis which builds on publicly-available data and models from various resources.

There are tools available for grid and free retrievals using Bayesian inference, synthetic photometry, interpolating a variety atmospheric and evolutionary model grids (including the possibility to add a custom grid), color-magnitude and color-color diagrams, empirical spectral analysis, spectral and photometric calibration, and analysis of emission lines. The package has been released on `PyPI <https://pypi.org/project/species/>`_ and is actively developed and maintained on Github.
There are tools available for grid and free retrievals using Bayesian inference, synthetic photometry, interpolating a variety atmospheric and evolutionary model grids (including the possibility to add a custom grid), color-magnitude and color-color diagrams, empirical spectral analysis, spectral and photometric calibration, and analysis of emission lines. The package has been released on `PyPI <https://pypi.org/project/species/>`_ and is actively developed and maintained on `Github <https://github.com/tomasstolker/species>`_.

**Important:** Importing the *species* package had become slow because of the many classes and functions that were implicitly imported. The initialization of the package has therefore been adjusted. Any functionalities should now be explicitly imported from the modules that they are part of.

Expand Down
31 changes: 13 additions & 18 deletions docs/tutorials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,58 +8,53 @@ This page contains a list of tutorials which highlight some of the functionaliti
.. tip::
Details on the various classes, functions, and parameters can be found in the `API documentation <https://species.readthedocs.io/en/latest/modules.html>`_.

**Spectral retrievals**
**Fitting model spectra, parameter retrievals**

.. toctree::
:maxdepth: 1

tutorials/fitting_model_spectra.ipynb
tutorials/atmospheric_retrieval.ipynb
tutorials/emission_line.ipynb
tutorials/flux_calibration.ipynb

**Atmospheric models**
**Atmospheric and evolutionary models**

.. toctree::
:maxdepth: 1

tutorials/model_spectra.ipynb
tutorials/data_model.ipynb

**Evolutionary models**

.. toctree::
:maxdepth: 1

tutorials/read_isochrone.ipynb

**Photometry**
**Synthetic photometry, magnitudes, fluxes**

.. toctree::
:maxdepth: 1

tutorials/flux_magnitude.ipynb
tutorials/synthetic_photometry.ipynb

**Companion data**
**Color and magnitude diagrams**

.. toctree::
:maxdepth: 1

tutorials/companion_data.ipynb
tutorials/mass_ratio.ipynb
tutorials/color_magnitude_broadband.ipynb
tutorials/color_magnitude_narrowband.ipynb

**Color and magnitude diagrams**
**Data of directly imaged planets**

.. toctree::
:maxdepth: 1

tutorials/color_magnitude_broadband.ipynb
tutorials/color_magnitude_narrowband.ipynb
tutorials/companion_data.ipynb
tutorials/mass_ratio.ipynb

**Miscellaneous**
**Spectral libraries**

.. toctree::
:maxdepth: 1

tutorials/flux_calibration.ipynb
tutorials/emission_line.ipynb
tutorials/spectral_library.ipynb

0 comments on commit 1e7cd67

Please sign in to comment.