The recommended installation method for signac-flow is via conda or pip. The software is tested for Python versions 3.8+ and signac versions 1.3+. 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-flow via conda (available on the conda-forge channel), with:
$ conda install -c conda-forge signac-flow
All additional dependencies will be installed automatically. To upgrade the package, execute:
$ conda update signac-flow
Install with pip¶
To install the package with the package manager pip, execute
$ pip install signac-flow --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
$ pip install signac-flow --user --upgrade
Source Code Installation¶
Alternatively you can clone the git repository and pip install it directly, or install directly from git.
# Option 1 git clone https://github.com/glotzerlab/signac-flow.git cd signac pip install . # Option 2 pip install git+https://github.com/glotzerlab/signac-flow.git