| Name | signac-flow JSON |
| Version |
0.29.0
JSON |
| download |
| home_page | None |
| Summary | Simple workflow management for signac projects. |
| upload_time | 2024-03-26 16:31:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License for the software signac-flow. Copyright (c) 2017, The Regents of the University of Michigan All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
workflow
management
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# <img src="https://raw.githubusercontent.com/glotzerlab/signac-flow/main/doc/images/palette-header.png" width="75" height="58"> signac-flow - manage workflows with signac
[](https://numfocus.org/sponsored-projects/affiliated-projects)
[](https://pypi.org/project/signac-flow/)
[](https://anaconda.org/conda-forge/signac-flow)
[](https://docs.signac.io)
[](https://github.com/glotzerlab/signac-flow/blob/main/LICENSE.txt)
[](https://pypistats.org/packages/signac-flow)
[](https://signac.io/slack-invite/)
[](https://twitter.com/signacdata)
[](https://github.com/glotzerlab/signac-flow/)
The [**signac** framework](https://signac.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.io).
That includes the definition of data pipelines, execution of data space operations and the submission of operations to high-performance super computers.
## Resources
- [Framework documentation](https://docs.signac.io/):
Examples, tutorials, topic guides, and package Python APIs.
- [Package documentation](https://docs.signac.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.
- [Slack workspace](https://signac.io/slack-invite/):
Chat about **signac-flow**.
- [**signac** website](https://signac.io/):
Framework overview and news.
## 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://docs.signac.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](http://docs.signac.io/en/latest/acknowledge.html).
**Thank you very much!**
The signac framework is a [NumFOCUS Affiliated Project](https://numfocus.org/sponsored-projects/affiliated-projects).
Raw data
{
"_id": null,
"home_page": null,
"name": "signac-flow",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "signac Developers <signac-support@umich.edu>",
"keywords": "workflow management",
"author": null,
"author_email": "\"Carl Simon Adorf et al.\" <csadorf@umich.edu>",
"download_url": "https://files.pythonhosted.org/packages/4e/86/5747f150cdc99e2b36577f65a18961a3283fb3c92388de097c35ef9d54bc/signac-flow-0.29.0.tar.gz",
"platform": null,
"description": "# <img src=\"https://raw.githubusercontent.com/glotzerlab/signac-flow/main/doc/images/palette-header.png\" width=\"75\" height=\"58\"> signac-flow - manage workflows with signac\n\n[](https://numfocus.org/sponsored-projects/affiliated-projects)\n[](https://pypi.org/project/signac-flow/)\n[](https://anaconda.org/conda-forge/signac-flow)\n[](https://docs.signac.io)\n[](https://github.com/glotzerlab/signac-flow/blob/main/LICENSE.txt)\n[](https://pypistats.org/packages/signac-flow)\n[](https://signac.io/slack-invite/)\n[](https://twitter.com/signacdata)\n[](https://github.com/glotzerlab/signac-flow/)\n\nThe [**signac** framework](https://signac.io) helps users manage and scale file-based workflows, facilitating data reuse, sharing, and reproducibility.\n\nThe **signac-flow** tool provides the basic components to set up simple to complex workflows for projects managed by the [**signac** framework](https://signac.io).\nThat includes the definition of data pipelines, execution of data space operations and the submission of operations to high-performance super computers.\n\n## Resources\n\n- [Framework documentation](https://docs.signac.io/):\n Examples, tutorials, topic guides, and package Python APIs.\n- [Package documentation](https://docs.signac.io/projects/flow/):\n API reference for the **signac-flow** package.\n- [Discussion board](https://github.com/glotzerlab/signac-flow/discussions/):\n Ask the **signac-flow** user community for help.\n- [Slack workspace](https://signac.io/slack-invite/):\n Chat about **signac-flow**.\n- [**signac** website](https://signac.io/):\n Framework overview and news.\n\n\n## Installation\n\nThe recommended installation method for **signac-flow** is through **conda** or **pip**.\nThe software is tested for Python versions 3.6+ and is built for all major platforms.\n\nTo install **signac-flow** *via* the [conda-forge](https://conda-forge.github.io/) channel, execute:\n\n```bash\nconda install -c conda-forge signac-flow\n```\n\nTo install **signac-flow** *via* **pip**, execute:\n\n```bash\npip install signac-flow\n```\n\n**Detailed information about alternative installation methods can be found in the [documentation](https://docs.signac.io/en/latest/installation.html).**\n\n\n## Testing\n\nYou can test this package by executing\n\n $ python -m pytest tests/\n\nwithin the repository root directory.\n\n\n## Acknowledgment\n\nWhen using **signac** as part of your work towards a publication, we would really appreciate that you acknowledge **signac** appropriately.\nWe have prepared examples on how to do that [here](http://docs.signac.io/en/latest/acknowledge.html).\n**Thank you very much!**\n\nThe signac framework is a [NumFOCUS Affiliated Project](https://numfocus.org/sponsored-projects/affiliated-projects).\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License for the software signac-flow. Copyright (c) 2017, The Regents of the University of Michigan All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Simple workflow management for signac projects.",
"version": "0.29.0",
"project_urls": {
"Documentation": "https://docs.signac.io",
"Download": "https://pypi.org/project/signac-flow/",
"Homepage": "https://signac.io",
"Issues": "https://github.com/glotzerlab/signac-flow/issues",
"Source": "https://github.com/glotzerlab/signac-flow"
},
"split_keywords": [
"workflow",
"management"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "93ea047ad5ae278d23809d1b81a1dc274d8c3f38213ca5bf535a57ee6c140d46",
"md5": "ecce8b6d7b76878f15c382bc97440ebd",
"sha256": "16e72827de1cadce566448f66c27ae97790a5e42a3320c17d0e503626c4137e1"
},
"downloads": -1,
"filename": "signac_flow-0.29.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ecce8b6d7b76878f15c382bc97440ebd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 165737,
"upload_time": "2024-03-26T16:31:35",
"upload_time_iso_8601": "2024-03-26T16:31:35.852643Z",
"url": "https://files.pythonhosted.org/packages/93/ea/047ad5ae278d23809d1b81a1dc274d8c3f38213ca5bf535a57ee6c140d46/signac_flow-0.29.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4e865747f150cdc99e2b36577f65a18961a3283fb3c92388de097c35ef9d54bc",
"md5": "968f47bcc8d100f6841d544a0e08fbcf",
"sha256": "64cd960a9a6b296897c6ada7e97044a9dd9d2cb3370ae65f7d0f38b12c8c2575"
},
"downloads": -1,
"filename": "signac-flow-0.29.0.tar.gz",
"has_sig": false,
"md5_digest": "968f47bcc8d100f6841d544a0e08fbcf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 159292,
"upload_time": "2024-03-26T16:31:37",
"upload_time_iso_8601": "2024-03-26T16:31:37.392902Z",
"url": "https://files.pythonhosted.org/packages/4e/86/5747f150cdc99e2b36577f65a18961a3283fb3c92388de097c35ef9d54bc/signac-flow-0.29.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-26 16:31:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "glotzerlab",
"github_project": "signac-flow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "signac-flow"
}
