https://github.com/glotzerlab/signac-flow

Workflow management for signac-managed data spaces.
https://github.com/glotzerlab/signac-flow

python signac workflow

Last synced: about 1 year ago
JSON representation

Workflow management for signac-managed data spaces.

• Host: GitHub
• URL: https://github.com/glotzerlab/signac-flow
• Owner: glotzerlab
• License: bsd-3-clause
• Created: 2019-01-30T23:27:23.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2025-04-01T13:40:14.000Z (about 1 year ago)
• Last Synced: 2025-04-04T05:01:32.090Z (about 1 year ago)
• Topics: python, signac, workflow
• Language: Python
• Homepage: https://signac.io/
• Size: 4.9 MB
• Stars: 49
• Watchers: 12
• Forks: 37
• Open Issues: 54
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.txt
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
#  signac-flow - manage workflows with signac

[![Affiliated with NumFOCUS](https://img.shields.io/badge/NumFOCUS-affiliated%20project-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org/sponsored-projects/affiliated-projects)

[![PyPI](https://img.shields.io/pypi/v/signac-flow.svg)](https://pypi.org/project/signac-flow/)

[![conda-forge](https://img.shields.io/conda/vn/conda-forge/signac-flow.svg?style=flat)](https://anaconda.org/conda-forge/signac-flow)

[![RTD](https://img.shields.io/readthedocs/signac.svg?style=flat)](https://signac.readthedocs.io/)

[![License](https://img.shields.io/github/license/glotzerlab/signac-flow.svg)](https://github.com/glotzerlab/signac-flow/blob/main/LICENSE.txt)

[![PyPI-downloads](https://img.shields.io/pypi/dm/signac-flow.svg?style=flat)](https://pypistats.org/packages/signac-flow)

[![Slack](https://img.shields.io/badge/Slack-chat%20support-brightgreen.svg?style=flat&logo=slack)](https://signac.readthedocs.io/slack-invite/)

[![Twitter](https://img.shields.io/twitter/follow/signacdata?style=social)](https://twitter.com/signacdata)

[![GitHub Stars](https://img.shields.io/github/stars/glotzerlab/signac-flow?style=social)](https://github.com/glotzerlab/signac-flow/)

The [**signac** framework](https://signac.readthedocs.io/) 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](https://signac.readthedocs.io/).

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](https://row.readthedocs.io), the actively maintained spiritual successor to **signac-flow**.

## Resources

- [Framework documentation](https://signac.readthedocs.io/):

  Examples, tutorials, topic guides, and package Python APIs.

- [Package documentation](https://signac.readthedocs.io/projects/flow/):

  API reference for the **signac-flow** package.

- [Discussion board](https://github.com/glotzerlab/signac-flow/discussions/):

  Ask the **signac-flow** user community for help.

## Installation

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](https://conda-forge.github.io/) channel, execute:

```bash

conda install -c conda-forge signac-flow

```

To install **signac-flow** *via* **pip**, execute:

```bash

pip install signac-flow

```

**Detailed information about alternative installation methods can be found in the [documentation](https://signac.readthedocs.io/en/latest/installation.html).**

## Testing

You can test this package by executing

    $ python -m pytest tests/

within the repository root directory.

## 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](https://signac.readthedocs.io/en/latest/acknowledge.html).

**Thank you very much!**

The signac framework is a [NumFOCUS Affiliated Project](https://numfocus.org/sponsored-projects/affiliated-projects).