Installation

The recommended installation method for signac is via conda or pip. The software is tested for Python versions 3.6+ and has minimal dependencies. Some features such as the HDF5 integration require additional packages. Supported Python and NumPy versions are determined according to the NEP 29 deprecation policy.

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

Note

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:

$ pip install pymongo passlib bcrypt --user

Source Code Installation

Alternatively you can clone the git repository and execute the setup.py script to install the package.

git clone https://github.com/glotzerlab/signac.git
cd signac
python setup.py install --user

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:

MongoDB database backend

required: pymongo

recommended: passlib, bcrypt

HDF5 integration

required: h5py