Installation

The signac framework consists of signac, signac-flow, signac-dashboard, and synced_collections. The synced_collections package is a standalone package containing data structures used by the core signac package. All other packages in the signac framework depend on signac core, which provides the data management functionality used by all other packages. Most users should install the signac and signac-flow packages, which are tested for Python 3.8+ and are built for all major platforms. For more details about the functionalities of individual packages, please see 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 signac signac-flow

Installation from Source

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

# Option 1
git clone https://github.com/glotzerlab/signac.git
cd signac
pip install .

# Option 2
pip install git+https://github.com/glotzerlab/signac.git

Build Status

signac

conda-forge signac PyPI signac

signac-flow

conda-forge signac-flow PyPI signac-flow

signac-dashboard

conda-forge signac-dashboard PyPI signac-dashboard

synced_collections

PyPI synced_collections