| Name | signac JSON |
| Version |
2.2.0
JSON |
| download |
| home_page | |
| Summary | Manage large and heterogeneous data spaces on the file system. |
| upload_time | 2024-02-14 15:18:08 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | BSD 3-Clause License for the software signac. Copyright (c) 2016, 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 |
simulation
database
index
collaboration
workflow
|
| 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/main/doc/images/palette-header.png" width="75" height="58"> signac - simple data management
[](https://numfocus.org/sponsored-projects/affiliated-projects)
[](https://pypi.org/project/signac/)
[](https://anaconda.org/conda-forge/signac)
[](https://github.com/glotzerlab/signac/actions)
[](https://docs.signac.io)
[](https://github.com/glotzerlab/signac/blob/main/LICENSE.txt)
[](https://pypistats.org/packages/signac)
[](https://signac.io/slack-invite/)
[](https://twitter.com/signacdata)
[](https://github.com/glotzerlab/signac/)
The [**signac** framework](https://signac.io) helps users manage and scale file-based workflows, facilitating data reuse, sharing, and reproducibility.
It provides a simple and robust data model to create a well-defined indexable storage layout for data and metadata.
This makes it easier to operate on large data spaces, streamlines post-processing and analysis and makes data collectively accessible.
## Resources
- [Framework documentation](https://docs.signac.io/):
Examples, tutorials, topic guides, and package Python APIs.
- [Package documentation](https://docs.signac.io/projects/core/):
API reference for the **signac** package.
- [Discussion board](https://github.com/glotzerlab/signac/discussions/):
Ask the **signac** user community for help.
- [Slack workspace](https://signac.io/slack-invite/):
Chat about **signac**.
- [**signac** website](https://signac.io/):
Framework overview and news.
## Installation
The recommended installation method for **signac** is through **conda** or **pip**.
The software is tested for Python 3.8+ and is built for all major platforms.
To install **signac** *via* the [conda-forge](https://conda-forge.github.io/) channel, execute:
```bash
conda install -c conda-forge signac
```
To install **signac** *via* **pip**, execute:
```bash
pip install signac
```
**Detailed information about alternative installation methods can be found in the [documentation](https://docs.signac.io/en/latest/installation.html).**
## Quickstart
The framework facilitates a project-based workflow.
Set up a new project:
```bash
$ mkdir my_project
$ cd my_project
$ signac init
```
and access the project handle:
```python
>>> project = signac.get_project()
```
## Testing
You can test this package by executing:
```bash
$ python -m pytest tests/
```
## 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://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": "",
"name": "signac",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "signac Developers <signac-support@umich.edu>",
"keywords": "simulation,database,index,collaboration,workflow",
"author": "",
"author_email": "\"Carl Simon Adorf et al.\" <csadorf@umich.edu>",
"download_url": "https://files.pythonhosted.org/packages/5a/56/2acc85fc06e51988940bcdfd7ccba97cea43cadd68f6adbd401493b85320/signac-2.2.0.tar.gz",
"platform": null,
"description": "# <img src=\"https://raw.githubusercontent.com/glotzerlab/signac/main/doc/images/palette-header.png\" width=\"75\" height=\"58\"> signac - simple data management\n\n[](https://numfocus.org/sponsored-projects/affiliated-projects)\n[](https://pypi.org/project/signac/)\n[](https://anaconda.org/conda-forge/signac)\n[](https://github.com/glotzerlab/signac/actions)\n[](https://docs.signac.io)\n[](https://github.com/glotzerlab/signac/blob/main/LICENSE.txt)\n[](https://pypistats.org/packages/signac)\n[](https://signac.io/slack-invite/)\n[](https://twitter.com/signacdata)\n[](https://github.com/glotzerlab/signac/)\n\nThe [**signac** framework](https://signac.io) helps users manage and scale file-based workflows, facilitating data reuse, sharing, and reproducibility.\n\nIt provides a simple and robust data model to create a well-defined indexable storage layout for data and metadata.\nThis makes it easier to operate on large data spaces, streamlines post-processing and analysis and makes data collectively accessible.\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/core/):\n API reference for the **signac** package.\n- [Discussion board](https://github.com/glotzerlab/signac/discussions/):\n Ask the **signac** user community for help.\n- [Slack workspace](https://signac.io/slack-invite/):\n Chat about **signac**.\n- [**signac** website](https://signac.io/):\n Framework overview and news.\n\n## Installation\n\nThe recommended installation method for **signac** is through **conda** or **pip**.\nThe software is tested for Python 3.8+ and is built for all major platforms.\n\nTo install **signac** *via* the [conda-forge](https://conda-forge.github.io/) channel, execute:\n\n```bash\nconda install -c conda-forge signac\n```\n\nTo install **signac** *via* **pip**, execute:\n\n```bash\npip install signac\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## Quickstart\n\nThe framework facilitates a project-based workflow.\nSet up a new project:\n\n```bash\n$ mkdir my_project\n$ cd my_project\n$ signac init\n```\n\nand access the project handle:\n\n```python\n>>> project = signac.get_project()\n```\n\n## Testing\n\nYou can test this package by executing:\n\n```bash\n$ python -m pytest tests/\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](https://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. Copyright (c) 2016, 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": "Manage large and heterogeneous data spaces on the file system.",
"version": "2.2.0",
"project_urls": {
"Documentation": "https://docs.signac.io",
"Download": "https://pypi.org/project/signac/",
"Homepage": "https://signac.io",
"Issues": "https://github.com/glotzerlab/signac/issues",
"Source": "https://github.com/glotzerlab/signac"
},
"split_keywords": [
"simulation",
"database",
"index",
"collaboration",
"workflow"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "50f9539dd020a2199cd067b7ad0c500531004fd54a7fdfe72519fdcdda91b45e",
"md5": "b4dce35c8fb7f80513c4262503a91be0",
"sha256": "a1681a6da40d7eb898612da0492ef2dead3a66adaae8f9ddae9a96020184369e"
},
"downloads": -1,
"filename": "signac-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4dce35c8fb7f80513c4262503a91be0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 129312,
"upload_time": "2024-02-14T15:18:06",
"upload_time_iso_8601": "2024-02-14T15:18:06.607954Z",
"url": "https://files.pythonhosted.org/packages/50/f9/539dd020a2199cd067b7ad0c500531004fd54a7fdfe72519fdcdda91b45e/signac-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5a562acc85fc06e51988940bcdfd7ccba97cea43cadd68f6adbd401493b85320",
"md5": "48ec993d90be53fdcd2e296120779059",
"sha256": "145dcf98e125db16a71a3dc1ced81c96094cbc347c690d77da9ce73a13319010"
},
"downloads": -1,
"filename": "signac-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "48ec993d90be53fdcd2e296120779059",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 159387,
"upload_time": "2024-02-14T15:18:08",
"upload_time_iso_8601": "2024-02-14T15:18:08.578175Z",
"url": "https://files.pythonhosted.org/packages/5a/56/2acc85fc06e51988940bcdfd7ccba97cea43cadd68f6adbd401493b85320/signac-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-14 15:18:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "glotzerlab",
"github_project": "signac",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "signac"
}
