INSTALL.rst

Installation

Ultraplot is published on PyPi and conda-forge. It can be installed with pip or conda as follows:

pip install ultraplot
conda install -c conda-forge ultraplot

The default install includes optional features (for example, pyCirclize-based plots). For a minimal install, use --no-deps and install the core requirements:

pip install ultraplot --no-deps
pip install -r requirements-minimal.txt

Likewise, an existing installation of ultraplot can be upgraded to the latest version with:

pip install --upgrade ultraplot
conda upgrade ultraplot

To install a development version of ultraplot, you can use pip install git+https://github.com/ultraplot/ultraplot.git or clone the repository and run pip install -e . inside the ultraplot folder.

ultraplot's only hard dependency is matplotlib. The soft dependencies are cartopy, basemap, xarray, and pandas. See the documentation for details.