signac-flow 0.6.4

Simple workflow management for signac projects.

README

About

The signac-flow tool provides the basic components to set up simple to complex workflows for projects as part of 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.

Maintainers

• Carl Simon Adorf ([e-mail])
• Vyas Ramasubramani ([e-mail])
• Bradley D. Dice ([e-mail])

Installation

The recommendend installation method for signac-flow is through conda or pip. The software is tested for Python versions 2.7 and 3.4+ and is built for all major platforms.

This package is available via the conda-forge conda channel:

conda install -c conda-forge signac-flow

or pip:

pip install --user signac-flow

Documentation

The framework documentation is hosted at https://docs.signac.io.

The API reference for this package is hosted at https://docs.signac.io/projects/flow/.

Acknowledgment

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!

Testing

You can test this package by executing

$ python -m unittest discover tests/

within the repository root directory.