Installation¶

Requirements¶

PubliPlots requires Python 3.9 or later and the following packages:

For the fastest installation, we recommend using uv:

uv pip install publiplots

Alternatively, you can use pip:

pip install publiplots

To install the latest development version from GitHub:

git clone https://github.com/jorgebotas/publiplots.git
cd publiplots
uv pip install -e .

Or with pip:

pip install -e .

If you want to contribute to PubliPlots, install the development dependencies:

uv pip install -e ".[dev]"

Or with pip:

pip install -e ".[dev]"

This will install additional packages for testing and code quality:

To build the documentation locally:

uv pip install -e ".[docs]"

Or with pip:

pip install -e ".[docs]"

This will install Sphinx, sphinx-gallery, and related documentation tools.

To verify that PubliPlots is installed correctly:

import publiplots as pp
print(pp.__version__)

This should print the installed version number.