The signac framework helps users manage and scale file-based workflows, facilitating data reuse, sharing, and reproducibility.
The signac-flow tool provides the basic components to set up simple to complex workflows for projects managed by the signac framework. That includes the definition of data pipelines, execution of data space operations and the submission of operations to high-performance super computers.
Note: Check out row, the actively maintained spiritual successor to signac-flow.
- Framework documentation: Examples, tutorials, topic guides, and package Python APIs.
- Package documentation: API reference for the signac-flow package.
- Discussion board: Ask the signac-flow user community for help.
- Slack workspace: Chat about signac-flow.
- signac website: Framework overview and news.
The recommended installation method for signac-flow is through conda or pip. The software is tested for Python versions 3.6+ and is built for all major platforms.
To install signac-flow via the conda-forge channel, execute:
conda install -c conda-forge signac-flowTo install signac-flow via pip, execute:
pip install signac-flowDetailed information about alternative installation methods can be found in the documentation.
You can test this package by executing
$ python -m pytest tests/
within the repository root directory.
When using signac as part of your work towards a publication, we would really appreciate that you acknowledge signac appropriately. We have prepared examples on how to do that here. Thank you very much!
The signac framework is a NumFOCUS Affiliated Project.