Getting Started

Installation

Official releases

Stable releases can be installed directly from the Python Package Index (PyPI):

$> 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 instructions for installing from version control or from a local source tree.

Dependencies

pyunicorn is implemented in Python 3 / Cython 3, is tested on Linux, macOS and Windows, and relies on the following packages:

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 .[docs]
$> cd docs; make clean html latexpdf