Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/klarh/flowws
A modular task workflow framework in python
https://github.com/klarh/flowws
analysis python workflow-engine
Last synced: about 2 months ago
JSON representation
A modular task workflow framework in python
- Host: GitHub
- URL: https://github.com/klarh/flowws
- Owner: klarh
- License: mit
- Created: 2019-03-01T14:57:12.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T15:27:48.000Z (12 months ago)
- Last Synced: 2024-09-15T11:50:48.948Z (4 months ago)
- Topics: analysis, python, workflow-engine
- Language: Python
- Size: 63.5 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://flowws.readthedocs.io/en/latest/)
# Introduction
`flowws` is an in-development framework for building modular, reusable
task workflows. The core library contains tools to abstract over
storage locations and parse arguments in a uniform way for both python
scripts and command-line-based execution. It is designed to help solve
the following problems:
- Composing tasks from a series of modular actions
- Parameterizing tasks and exposing interfaces for both interactive and batch execution
- Improving reproducibility by encapsulating parameters within workflow definitions
`flowws` is being developed in conjunction with other projects, including:
- [hoomd-flowws](https://github.com/klarh/hoomd_flowws): perform simulations with [hoomd-blue](https://github.com/glotzerlab/hoomd-blue).
- [flowws-analysis](https://github.com/klarh/flowws-analysis): run analysis and visualization workflows
- [flowws-freud](https://github.com/klarh/flowws-freud): molecular simulation-specific modules for `flowws-analysis`
- [flowws-examples](http://github.com/klarh/flowws-examples): example workflows using the above projects
## Installation
Install flowws from PyPI:
```
pip install flowws
```
Alternatively, install from source:
```
pip install git+https://github.com/klarh/flowws.git#egg=flowws
```
## Documentation
Browse more detailed documentation
[online](https://flowws.readthedocs.io) or build the sphinx
documentation from source:
```
git clone https://github.com/klarh/flowws
cd flowws/doc
pip install -r requirements.txt
make html
```
## Examples
The [flowws-examples](http://github.com/klarh/flowws-examples) project
contains interactive notebook examples that demonstrate various
workflows.