From 1e7cd67ca6f7b558b302c0d7eb08e3ee5569a16e Mon Sep 17 00:00:00 2001 From: Tomas Stolker Date: Thu, 1 Feb 2024 15:39:34 +0100 Subject: [PATCH] Minor update in documation and README --- README.rst | 2 +- docs/tutorials.rst | 31 +++++++++++++------------------ 2 files changed, 14 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index c3c68677..d46a56f7 100644 --- a/README.rst +++ b/README.rst @@ -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 `_ 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 `_ and is actively developed and maintained on `Github `_. **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. diff --git a/docs/tutorials.rst b/docs/tutorials.rst index 9a0943ce..49c67a9d 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -8,30 +8,26 @@ 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 `_. -**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 @@ -39,27 +35,26 @@ This page contains a list of tutorials which highlight some of the functionaliti 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 +