Metadata-Version: 2.4
Name: exoctk
Version: 2026.7
Summary: Exoplanet Characterization Toolkit
Author: Matthew Bourque, Néstor Espinoza, Joseph Filippazzo, Mees Fix, Teagan King, Catherine Martlin, Jennifer Medina, Natasha Batalha, Taylor James Bell, Michael Fox, Jules Fowler, Jonathan Fraine, Matthew Hill, Nikole Lewis, Kevin Stevenson, Jeff Valenti, Hannah Wakeford
Project-URL: Repository, https://github.com/ExoCTK/exoctk
Keywords: astronomy,python
Classifier: Programming Language :: Python
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: astropy<9,>=5.3.1
Requires-Dist: astroquery<1,>=0.4.10
Requires-Dist: batman-package<3,>=2.5.3
Requires-Dist: bibtexparser<2,>=1.2.0
Requires-Dist: bokeh<4,>=3.0
Requires-Dist: docopt<1,>=0.6.2
Requires-Dist: flask<4,>=1.1.2
Requires-Dist: flask_wtf<2,>=0.14.3
Requires-Dist: h5py<4,>=3.2.1
Requires-Dist: hotsoss<1,>=0.1.11
Requires-Dist: matplotlib<4,>=3.4.1
Requires-Dist: numpy<3,>=2.0.0
Requires-Dist: pandas<4,>=2.0.3
Requires-Dist: platon<7,>=5.1.2
Requires-Dist: pysiaf<1,>=0.28.0
Requires-Dist: regions<1,>=0.5
Requires-Dist: scipy<2,>=1.11.1
Requires-Dist: sqlalchemy<3,>=1.4.4
Requires-Dist: svo_filters<1,>=0.5.3
Requires-Dist: wtforms<4,>=2.3.3
Requires-Dist: jwst_gtvt<2,>=1.1.1
Provides-Extra: test
Requires-Dist: pytest<10,>=6.2.2; extra == "test"
Requires-Dist: pytest-cov<8,>=7.0.0; extra == "test"
Requires-Dist: pytest-xdist; extra == "test"
Provides-Extra: docs
Requires-Dist: esbonio<3,>=2.0.0; extra == "docs"
Requires-Dist: sphinx<10,>=3.5.3; extra == "docs"
Requires-Dist: sphinx_astropy<2,>=1.10; extra == "docs"
Requires-Dist: sphinx_rtd_theme<4,>1.2.0; extra == "docs"
Requires-Dist: stsci_rtd_theme<2,>=1.0.1; extra == "docs"
Requires-Dist: numpydoc<2,>=1.1.0; extra == "docs"
Provides-Extra: server
Requires-Dist: celery[redis]<6,>=5; extra == "server"
Requires-Dist: gunicorn<27,>=20.1.0; extra == "server"
Provides-Extra: container-test
Requires-Dist: selenium<5,>=4; extra == "container-test"
Requires-Dist: tabulate<1,>=0.10.0; extra == "container-test"
Dynamic: license-file

.. image:: https://raw.githubusercontent.com/ExoCTK/exoctk/main/exoctk/data/images/ExoCTK_logo.png
    :alt: ExoCTK Logo

.. image:: https://img.shields.io/github/release/ExoCTK/exoctk.svg
    :target: https://github.com/ExoCTK/exoctk/releases/latest/
.. image:: https://img.shields.io/github/license/ExoCTK/exoctk.svg
    :target: https://github.com/ExoCTK/exoctk/blob/master/LICENSE.rst
.. image:: https://github.com/ExoCTK/exoctk/actions/workflows/build.yml/badge.svg?branch=main
    :target: https://github.com/ExoCTK/exoctk/actions/workflows/build.yml
    :alt: Build status
.. image:: https://github.com/ExoCTK/exoctk/actions/workflows/test.yml/badge.svg?branch=main
    :target: https://github.com/ExoCTK/exoctk/actions/workflows/test.yml
    :alt: Test status
.. image:: https://readthedocs.org/projects/exoctk/badge/?version=latest
    :target: https://exoctk.readthedocs.io/en/latest/?badge=latest
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4556063.svg
   :target: https://doi.org/10.5281/zenodo.4556063
.. image:: https://img.shields.io/badge/powered%20by-STScI-blue.svg?colorA=707170&colorB=3e8ddd&style=flat
   :target: http://www.stsci.edu


Introduction
------------
ExoCTK is an open-source, modular data analysis package focused primarily on atmospheric characterization of exoplanets. The subpackages included are:

* Contamination and Visibility Calculator
* Integrations and Groups Calculator
* Transit Light-Curve Fitter
* Limb Darkening Calculator
* Phase Constraint Calculator
* Atmospheric Forward Modeling

For more information on each package visit our documentation at `readthedocs <https://exoctk.readthedocs.io/en/latest/>`_.

Most packages are also available through interactive tools at our `web portal <https://exoctk.stsci.edu/>`_.

Installation
------------

The following are instructions on how to install the ``exoctk`` package for both users and contributors.  The ``exoctk`` repository provides a ``conda`` environment containing all of the dependencies needed to install and execute the ``exoctk`` software.


Download Anaconda or Miniconda
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You must first have a working installation of ``conda`` (or ``mamba``) for Python 3.  If you do not yet have this on your system, you can visit the following links for download and installation instructions:

- `Miniforge <https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html>`_
- `Miniconda <https://conda.io/en/latest/miniconda.html>`_
- `micromamba <https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html>`_


Obtain the ``exoctk`` Package
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To obtain the ``exoctk`` package with the necessary environment file, clone the repository directly from GitHub:

.. code-block:: sh

    git clone https://github.com/ExoCTK/exoctk.git
    cd exoctk


Environment Installation
~~~~~~~~~~~~~~~~~~~~~~~~
You can create the ExoCTK ``conda`` environment via the ``exoctk-env.yml`` file with the following ``conda`` (or ``mamba``) command:

.. code-block:: sh

    conda env create -f exoctk-env.yml

.. tip::
    To specify a specific Python version (or any additional Conda packages), add them to the end of the ``conda env create`` command:

    .. code-block:: sh

        conda env create -f exoctk-env.yml python==3.11


One can activate the newly-created environment with:

.. code-block:: sh

    conda activate exoctk-env

After activating the environment, install ``exoctk`` from the cloned source.

Package Installation From Source
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To install the latest development version of ``exoctk`` use ``pip`` to install directly from the cloned source:

.. code-block:: sh

    pip install -e .


Obtain the ``exoctk`` Data
~~~~~~~~~~~~~~~~~~~~~~~~~~

To obtain the necessary data to run ExoCTK, you just need to execute the ``exoctk.utils.download_exoctk_data()`` function.  This function will download a series of compressed files, extract the files, and organize them into an ``exoctk_data/`` directory.  Note that this can only be done once the ``exoctk`` package has been fully installed (see instructions above).

Lastly, export an environment variable for ``EXOCTK_DATA``.

- For Mac OS/Linux, add the line

.. code-block:: sh

    export EXOCTK_DATA='/path/to/your/unzipped/directory/exoctk_data/'

to your `.bashrc` or `.bash_profile`.

- For Windows, add an environment variable using System Utility.



Missing Dependencies?
~~~~~~~~~~~~~~~~~~~~~
If you find that the ``exoctk`` environment is missing a required dependency, please feel free to `submit a GitHub Issue <https://github.com/ExoCTK/exoctk/issues>`_ detailing the problem.


Citation
--------

If you use ExoCTK for work/research presented in a publication (whether directly, or as a dependency to another package), we recommend and encourage the following acknowledgment:

::

  This research made use of the open source Python package exoctk, the Exoplanet Characterization Toolkit (Bourque et al, 2021).

where (Bourque et al, 2021) is a citation of the Zenodo record, e.g.:

::

    @software{matthew_bourque_2021_4556063,
      author       = {Matthew Bourque and
                      Néstor Espinoza and
                      Joseph Filippazzo and
                      Mees Fix and
                      Teagan King and
                      Catherine Martlin and
                      Jennifer Medina and
                      Natasha Batalha and
                      Michael Fox and
                      Jules Fowler and
                      Jonathan Fraine and
                      Matthew Hill and
                      Nikole Lewis and
                      Kevin Stevenson and
                      Jeff Valenti and
                      Hannah Wakeford},
      title        = {The Exoplanet Characterization Toolkit (ExoCTK)},
      month        = feb,
      year         = 2021,
      publisher    = {Zenodo},
      version      = {1.0.0},
      doi          = {10.5281/zenodo.4556063},
      url          = {https://doi.org/10.5281/zenodo.4556063}
    }

Want to stay up-to-date with our releases and updates?
------------------------------------------------------

Subscribe to our newsletter by sending an email with a blank body and subject to ``exoctk-news-subscribe-request@maillist.stsci.edu`` from the email you want to enroll. You should then receive a confirmation email with instructions on how to confirm your subscription, please be sure to do so within 48 hours.
