Installation

All packages in the signac framework depend on the core signac package, which provides the data management functionality used by all other packages (See Packages (API) for more information). Most users should install the signac and the signac-flow packages, which are tested for Python version 2.7.x and 3.4+ and do not have any hard dependencies, ensuring that no packages outside the signac framework are required for basic functionality. Please see the individual package documentation for instructions on how to install additional packages.

Install with conda

The recommended installation method for installing signac packages is via conda. The signac packages are distributed via the conda-forge channel. For a standard installation, execute:

$ conda install -c conda-forge signac signac-flow

Tip

Consider adding the conda-forge channel to your default channels with: $ conda config --add channels conda-forge.

Install with pip

For a standard installation with pip, execute:

$ pip install --user signac signac-flow

Note

If you want to install packages for all users on a machine, you can remove the --user option in the install command.

Installation from Source

Alternatively, you can clone any of the package’s source code repositories and install them manually. For example, to install the signac core package you can execute the following code:

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

Note

If you want to install packages for all users on a machine, you can remove the --user option in the install command.