Skip to content

Commit

Permalink
Merge da3071b into 2dff899
Browse files Browse the repository at this point in the history
  • Loading branch information
Tomas Stolker committed Dec 16, 2020
2 parents 2dff899 + da3071b commit f45027a
Show file tree
Hide file tree
Showing 11 changed files with 240 additions and 105 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
*species*
=========

**s**\ pectral and **p**\ hotometric **e**\ xamination **c**\ ode for **i**\ nvestigating **e**\ xoplanet and **s**\ ubstellar atmospheres
**spe**\ctral **c**\ haracterization and **i**\ nference for **e**\ xoplanet **s**\ cience

.. image:: https://badge.fury.io/py/species.svg
:target: https://badge.fury.io/py/species
Expand All @@ -27,7 +27,7 @@
.. image:: https://img.shields.io/badge/arXiv-1912.13316-orange.svg?style=flat
:target: https://arxiv.org/abs/1912.13316

*species* is a toolkit for atmospheric characterization of exoplanets and brown dwarfs. It provides a coherent framework for spectral and photometric analysis which builds on publicly-available data from various resources such as spectral and photometric libraries, atmospheric models, and evolutionary tracks. There are tools available for grid retrievals with Bayesian inference, color-magnitude diagrams, spectral and photometric calibration, and synthetic photometry. The package has been released on `PyPI <https://pypi.org/project/species/>`_ and is actively developed and maintained on Github.
*species* is a toolkit for atmospheric characterization of directly imaged exoplanets and brown dwarfs. 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 atmospheric retrievals with Bayesian inference, color-magnitude and color-color diagrams, spectral and photometric calibration, and synthetic photometry. The package is has been released on `PyPI <https://pypi.org/project/species/>`_ and is actively developed and maintained on Github.

Documentation
-------------
Expand All @@ -42,11 +42,11 @@ Please cite `Stolker et al. (2020) <https://ui.adsabs.harvard.edu/abs/2020A%26A.
Contributing
------------

Contributions are welcome, please consider forking the repository and creating a pull request. Bug reports can be provided by creating an `issue <https://github.com/tomasstolker/species/issues>`_ on the Github page.
Contributions are welcome so please consider forking the repository and creating a pull request. Bug reports can be provided by creating an `issue <https://github.com/tomasstolker/species/issues>`_ on the Github page.

License
-------

Copyright 2018-2020 Tomas Stolker
Copyright 2018-2021 Tomas Stolker

*species* is distributed under the MIT License. See the LICENSE file for the terms and conditions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
# -- Project information -----------------------------------------------------

project = 'species'
copyright = '2018-2020, Tomas Stolker'
copyright = '2018-2021, Tomas Stolker'
author = 'Tomas Stolker'

# The short X.Y version
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ In this case the database is stored in the working folder and an absolute path p
>>> import os
>>> os.getcwd()
The workflow with *species* is now initiated with :class:`~species.core.setup.SpeciesInit`:
The workflow with *species* can now be initiated with the :class:`~species.core.setup.SpeciesInit` class:

.. code-block:: python
>>> import species
>>> species.SpeciesInit()
A configuration file with default values is automatically created when `species` is initiated and the configuration file is not present in the working folder.
Alternatively, a configuration file with default values is automatically created when `species` is initiated and the configuration file is not present in the working folder.

.. tip::
The same `data_folder` can be used in multiple configuration files. In this way, the data is only downloaded once and easily reused by a new instance of :class:`~species.core.setup.SpeciesInit`. Also the HDF5 database can be reused by simply including the same `database` in the configuration file.

0 comments on commit f45027a

Please sign in to comment.