The recommended installation method for signac is via conda or pip. The software is tested for Python versions 3.8+ and has minimal dependencies. Some features such as the HDF5 integration require additional packages. The signac framework uses the NEP 29 deprecation policy as a guideline for when to drop support for Python and NumPy versions, and does not guarantee support beyond the versions recommended in that proposal.

Install with conda

You can install signac via conda (available on the conda-forge channel), with:

$ conda install -c conda-forge signac

All additional dependencies will be installed automatically. To upgrade the package, execute:

$ conda update signac

Install with pip

To install the package with the package manager pip, execute

$ pip install signac --user


It is highly recommended to install the package into the user space and not as superuser!

To upgrade the package, simply execute the same command with the --upgrade option.

$ pip install signac --user --upgrade

Consider installing optional dependencies.

Source Code Installation

Alternatively you can clone the git repository and pip install it directly (Option 1), or install directly from git (Option 2).

# Option 1
git clone
cd signac
pip install .

# Option 2
pip install git+

Consider installing optional dependencies.

Optional dependencies

Unless you install via conda, optional dependencies are not installed automatically. In case you want to use extra features that require external packages, you need to install these manually.

Extra features with dependencies:

HDF5 integration

required: h5py