Installation

Requirements

yaml2plot requires Python 3.8 or later and the following dependencies:

Install yaml2plot from PyPI using pip:

pip install yaml2plot

If you want to contribute to yaml2plot or need the latest development version:

git clone https://github.com/Jianxun/yaml2plot.git
cd yaml2plot
pip install -e ".[dev]"

This installs yaml2plot in development mode with additional dependencies for testing and development.

To build the documentation locally:

pip install "yaml2plot[docs]"

This includes:

For enhanced Jupyter notebook support:

pip install "yaml2plot[jupyter]"

This includes:

For development and testing:

pip install "yaml2plot[dev]"

This includes testing, linting, and formatting tools:

To verify your installation, run:

import yaml2plot as y2p
print(y2p.__version__)

This should print the version number without any errors.