Metadata-Version: 2.1
Name: species
Version: 0.5.3
Summary: Toolkit for atmospheric characterization of directly imaged exoplanets
Home-page: https://github.com/tomasstolker/species
Author: Tomas Stolker
Author-email: stolker@strw.leidenuniv.nl
License: MIT
Project-URL: Documentation, https://species.readthedocs.io
Keywords: species
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: astropy (~=5.0.0)
Requires-Dist: astroquery (~=0.4.0)
Requires-Dist: corner (~=2.2.0)
Requires-Dist: emcee (~=3.1.0)
Requires-Dist: exo-k (~=1.1.0)
Requires-Dist: h5py (~=3.6.0)
Requires-Dist: matplotlib (~=3.5.0)
Requires-Dist: molmass (~=2021.6.0)
Requires-Dist: numba (~=0.55.0)
Requires-Dist: numpy (~=1.21.0)
Requires-Dist: pandas (~=1.4.0)
Requires-Dist: PyMieScatt (~=1.8.0)
Requires-Dist: pymultinest (~=2.11.0)
Requires-Dist: scipy (~=1.8.0)
Requires-Dist: spectres (~=2.1.0)
Requires-Dist: specutils (~=1.7)
Requires-Dist: tqdm (~=4.63.0)
Requires-Dist: typeguard (~=2.13.0)
Requires-Dist: xlrd (~=2.0.0)

*species*
=========

**spe**\ctral **c**\ haracterization and **i**\ nference for **e**\ xoplanet **s**\ cience

.. image:: https://img.shields.io/pypi/v/species
   :target: https://pypi.python.org/pypi/species

.. image:: https://img.shields.io/pypi/pyversions/species
   :target: https://pypi.python.org/pypi/species

.. image:: https://github.com/tomasstolker/species/workflows/CI/badge.svg?branch=main
   :target: https://github.com/tomasstolker/species/actions

.. image:: https://img.shields.io/readthedocs/species
   :target: http://species.readthedocs.io

.. image:: https://codecov.io/gh/tomasstolker/species/branch/main/graph/badge.svg?token=LSSCPMJ5JH
   :target: https://codecov.io/gh/tomasstolker/species

.. image:: https://img.shields.io/codefactor/grade/github/tomasstolker/species
   :target: https://www.codefactor.io/repository/github/tomasstolker/species

.. image:: https://img.shields.io/github/license/tomasstolker/species
   :target: https://github.com/tomasstolker/species/blob/main/LICENSE

.. image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/tomasstolker/species/HEAD

*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 both grid retrievals and free retrievals with Bayesian inference, color-magnitude and color-color diagrams, a variety of model grids, empirical spectral analysis, spectral and photometric calibration, analysis of emission lines, and synthetic photometry. The package has been released on `PyPI <https://pypi.org/project/species/>`_ and is actively developed and maintained on Github.

Documentation
-------------

Documentation can be found at `http://species.readthedocs.io <http://species.readthedocs.io>`_.

Tutorials
---------

There are several `Jupyter notebooks <https://species.readthedocs.io/en/latest/tutorials.html>`_ with tutorials that showcase the workflow and available tools. They can also be executed on `Binder <https://mybinder.org/v2/gh/tomasstolker/species/HEAD>`_ by navigating to the *docs/tutorials* folder.

Attribution
-----------

Please cite `Stolker et al. (2020) <https://ui.adsabs.harvard.edu/abs/2020A%26A...635A.182S/abstract>`_ whenever results from *species* are used in a publication. Please also make sure to give credit to the relevant papers regarding the use of the publicly available data that *species* benefits from.

Contributing
------------

Contributions are welcome so please consider `forking <https://help.github.com/en/articles/fork-a-repo>`_ the repository and creating a `pull request <https://github.com/tomasstolker/pycrires/pulls>`_. Bug reports and feature requests can be provided by creating an `issue <https://github.com/tomasstolker/pycrires/issues>`_ on the Github page.

License
-------

Copyright 2018-2022 Tomas Stolker

*species* is distributed under the MIT License. See `LICENSE <https://github.com/tomasstolker/pycrires/blob/main/LICENSE>`_ for the terms and conditions.


