Getting Started¶
Installation¶
Official releases¶
Stable releases can be installed from the Python Package Index, using a Python package manager such as pip or uv:
$> pip install pyunicorn
Alternatively, source distributions can be downloaded from the GitHub Releases.
On Windows, please first install the latest version of the Microsoft C++ Build Tools, which is required for compiling Cython modules.
Current development version¶
In order to use a newer version, please follow the pip or uv instructions for installing from version control.
Dependencies¶
pyunicorn is implemented in Python 3 /
Cython 3, is tested on Linux
and Windows, and relies on the following packages:
Required:
python-igraph (for
Network)h5netcdf (for
Data,NetCDFDictionary)tqdm (for progress bars)
Optional:
Matplotlib, Cartopy (for plotting features)
mpi4py (for parallelizing costly computations)
Sphinx (for generating documentation)
Jupyter Notebook (for tutorial notebooks)
Documentation¶
For extensive HTML documentation, jump right to the homepage. In a local source tree,
HTML and PDF documentation can be generated using Sphinx:
$> pip install --group docs
$> cd docs; make clean html latexpdf
Tutorials¶
For some example applications, look into the self-explanatory tutorial notebooks: either in the documentation section Tutorials, or in the corresponding source folder.