Skip to content

Commit

Permalink
Merge c897342 into f4d3221
Browse files Browse the repository at this point in the history
  • Loading branch information
tomasstolker committed Mar 5, 2021
2 parents f4d3221 + c897342 commit 013f902
Show file tree
Hide file tree
Showing 11 changed files with 890 additions and 242 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Expand Up @@ -4,7 +4,10 @@ docs/_build
docs/tutorials/species_config.ini
docs/tutorials/species_database.hdf5
docs/tutorials/*.png
docs/tutorials/*.fits
docs/tutorials/*.dat
docs/tutorials/data/*
docs/tutorials/ultranest/*
docs/tutorials/.ipynb_checkpoints/*
build/
dist/
Expand Down
3 changes: 3 additions & 0 deletions Makefile
Expand Up @@ -43,10 +43,13 @@ clean:
rm -rf .pytest_cache/
rm -rf docs/_build/
rm -rf docs/tutorials/data/
rm -rf docs/tutorials/ultranest/
rm -rf docs/tutorials/.ipynb_checkpoints
rm -f docs/tutorials/species_config.ini
rm -f docs/tutorials/species_database.hdf5
rm -f docs/tutorials/*.png
rm -f docs/tutorials/*.fits
rm -f docs/tutorials/*.dat
rm -rf build/
rm -rf dist/
rm -rf species.egg-info/
Expand Down
8 changes: 4 additions & 4 deletions docs/tutorials.rst
Expand Up @@ -5,21 +5,21 @@ Tutorials

This page contains a list of tutorials which highlight some of the functionalities of `species`. These examples are also available as `Jupyter notebook <https://github.com/tomasstolker/species/tree/master/docs/tutorials>`_. Some of tutorials are still work in progress and more examples will be added in the future. Please contact Tomas Stolker if you have questions regarding a specific science case (see :ref:`about` section) or `create an issue <https://github.com/tomasstolker/species/issues>`_ if you encounter any problems with the tutorials.

.. warning::
The last tutorial is somewhat outdated and incomplete because `species` has been under continuous development. If anything is unclear or causes an error, then please have a look at the `API documentation <https://species.readthedocs.io/en/latest/modules.html>`_, which is kept up-to-date, or contact Tomas Stolker (see :ref:`about` section).
.. tip::
Details on the various classes, functions, and parameters can be found in the `API documentation <https://species.readthedocs.io/en/latest/modules.html>`_.

.. toctree::
:maxdepth: 1

tutorials/flux_magnitude.ipynb
tutorials/synthetic_photometry.ipynb
tutorials/spectral_library.ipynb
tutorials/color_magnitude_broadband.ipynb
tutorials/color_magnitude_narrowband.ipynb
tutorials/atmospheric_models.ipynb
tutorials/data_model.ipynb
tutorials/flux_calibration.ipynb
tutorials/spectral_library.ipynb
tutorials/fitting_model_spectra.ipynb
tutorials/flux_calibration.ipynb

.. important::
A flux calibrated spectrum of Vega is used for the conversion between a flux density and magnitude. The magnitude of Vega is set to 0.03 for all filters. If needed, the magnitude of Vega can be changed with the ``vega_mag`` attribute of a ``SyntheticPhotometry`` object:
Expand Down

0 comments on commit 013f902

Please sign in to comment.