yieldplotlib 1.2.0

A Python pipeline to generate plots for exoplanet yield simulations.

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.

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:

venv

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.

conda

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.

Installing yieldplotlib

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.

Authors

Corey Spohn (@CoreySpohn)

Sarah Steiger (@steigersg)