=============
petitRADTRANS
=============

.. image:: https://img.shields.io/pypi/v/petitRADTRANS
   :target: https://pypi.org/project/petitRADTRANS/
   :alt: Pypi version

.. image:: https://img.shields.io/readthedocs/petitradtrans
   :target: https://petitradtrans.readthedocs.io/en/latest/
   :alt: documentation: https://petitradtrans.readthedocs.io/en/latest/

.. image:: https://img.shields.io/gitlab/license/mauricemolli/petitRADTRANS
   :target: https://gitlab.com/mauricemolli/petitRADTRANS/-/blob/master/LICENSE
   :alt: licence: MIT

.. image:: https://img.shields.io/badge/data-Keeper-darkred
   :target: https://keeper.mpdl.mpg.de/d/ccf25082fda448c8a0d0/
   :alt: data: https://keeper.mpdl.mpg.de/d/ccf25082fda448c8a0d0/

.. image:: https://img.shields.io/badge/DOI-10.1051%2F0004--6361%2F201935470-blue
   :target: https://doi.org/10.1051/0004-6361/201935470
   :alt: DOI: 10.1051/0004-6361/201935470

.. image:: https://joss.theoj.org/papers/10.21105/joss.05875/status.svg
   :target: https://doi.org/10.21105/joss.05875
   :alt: DOI: 10.21105/joss.05875

.. image:: https://joss.theoj.org/papers/10.21105/joss.07028/status.svg
   :target: https://doi.org/10.21105/joss.07028
   :alt: DOI: 10.21105/joss.07028

**An easy-to-use Python package for calculating exoplanet spectra**

Welcome to the repository of petitRADTRANS, an easy-to-use code for the calculation of exoplanet spectra.
petitRADTRANS allows the calculation of emission or transmission spectra, at low or high resolution, clear or cloudy,
and includes a retrieval module to fit a petitRADTRANS model to your spectral data.

Documentation
=============
The code documentation, installation guide, and tutorial can be found at `https://petitradtrans.readthedocs.io <https://petitradtrans.readthedocs.io>`_.

Attribution
===========
If you use petitRADTRANS in your work, please cite the following articles:

- for petitRADTRANS itself: `Mollière et al. 2019 <https://doi.org/10.1051/0004-6361/201935470>`_
- for the retrieval package: `Nasedkin et al. 2024 <https://doi.org/10.21105/joss.05875>`_
- for petitRADTRANS 3+: `Blain et al. 2024 <https://doi.org/10.21105/joss.07028>`_

License
=======
Copyright 2019-2024 the pRT team

petitRADTRANS is available under the MIT license.
See the LICENSE file for more information.