Metadata-Version: 2.4
Name: yieldplotlib
Version: 0.4.0
Summary: A Python pipeline to generate plots for exoplanet yield simulations.
Project-URL: Homepage, https://github.com/HWO-Yield-Visualizations/yieldplotlib
Project-URL: Issues, https://github.com/HWO-Yield-Visualizations/yieldplotlib/issues
Author-email: Corey Spohn <corey.a.spohn@nasa.gov>, Sarah Steiger <ssteiger@stsci.edu>
License: MIT License
        
        Copyright (c) 2024 Corey Spohn
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.9
Requires-Dist: astropy
Requires-Dist: colorspacious
Requires-Dist: docopt
Requires-Dist: exosims
Requires-Dist: lod-unit>=1.6.0
Requires-Dist: matplotlib
Requires-Dist: pyparsing>=3.1.4
Requires-Dist: synphot
Requires-Dist: tqdm
Requires-Dist: yippy
Provides-Extra: docs
Requires-Dist: matplotlib; extra == 'docs'
Requires-Dist: myst-nb; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-autoapi; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
Requires-Dist: sphinx-book-theme; extra == 'docs'
Provides-Extra: test
Requires-Dist: hypothesis; extra == 'test'
Requires-Dist: nox; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

<p align="center">
  <img width = 250 src="https://raw.githubusercontent.com/coreyspohn/yieldplotlib/main/docs/_static/logo.png" alt="yieldplotlib logo" />
  <br><br>
</p>

<p align="center">
  <a href="https://pypi.org/project/yieldplotlib/"><img src="https://img.shields.io/pypi/v/yieldplotlib.svg?style=flat-square&logo=pypi" alt="PyPI"/></a>
  <a href="https://yieldplotlib.readthedocs.io"><img src="https://readthedocs.org/projects/yieldplotlib/badge/?version=latest&style=flat-square" alt="Documentation Status"/></a>
  <a href="https://github.com/coreyspohn/yieldplotlib/?tab=coc-ov-file"><img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=flat-square" alt="Code of Conduct"/></a>
  <a href="https://doi.org/10.5281/zenodo.15013341"><img src="https://img.shields.io/badge/DOI-10.5281/zenodo.15013341-blue?style=flat-square" alt="DOI"></a>
</p>
<!-- <a href="https://github.com/coreyspohn/yieldplotlib/actions/workflows/ci.yml/"><img src="https://img.shields.io/github/actions/workflow/status/coreyspohn/yieldplotlib/ci.yml?branch=main&logo=github&style=flat-square" alt="CI"/></a> -->


yieldplotlib
---------------------
`yieldplotlib` is a Python library created by the Visualizations Task Group of
the Exoplanet Science Yield Working Group (ESYWG) under the HWO Project Office.
The goal of this library is to communicate the results of the Exoplanet yield codes
to the broader community in a clear and visually appealing way. The library is
designed interpret the outputs of yield codes (AYO and EXOSIMS) and produce
publication-quality plots.

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

Documentation for `yieldplotlib` is hosted on
[Read the Docs](https://yieldplotlib.readthedocs.io/en/latest/#).

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

Before installing, we recommend running `yieldplotlib` in a clean conda or
virtual environment. This is done by using `venv`, `virtualenv`, `uv`, `conda`,
or a similar tool. We recommend `venv` or `conda` if you are unfamiliar with
this process which can be used as follows:

##### <u> venv </u>
```bash
python3 -m venv .venv
source .venv/bin/activate
```
That creates a new "virtual environment" in the `.venv` directory and
activates it. Now when you run `python` commands it will not be from your
system level python installation, but from the one in the `.venv`
directory. To deactivate the environment, run `deactivate` from your shell.

##### <u> conda </u>

```bash
conda create -n ypl
conda activate ypl
```
Here we have named our environment `ypl`, but you can theoretically name it
whatever you like.

That creates a new "virtual environment" in the `conda/envs` directory and
activates it. Now when you run `python` commands it will not be from your
system level python installation, but from the one in the `envs/bin`
directory. To deactivate the environment, run `deactivate` from your shell.

##### <u> Installing yieldplotlib </u>

`yieldplotlib` is pip installable via PyPI and the latest release version can
be installed by running:

`pip install yieldplotlib`

You can also download the development version with an editable install by
cloning the repository and running:

```
cd yieldplotlib
pip install -e .
```
For more information on yieldplotlib development, please also see the
[Developer Documentation](https://yieldplotlib.readthedocs.io/en/latest/user/dev.html).

Authors
---------------------

Corey Spohn (@CoreySpohn)

Sarah Steiger (@steigersg)
