https://github.com/glotzerlab/signac
Manage large and heterogeneous data spaces on the file system.
https://github.com/glotzerlab/signac
data data-management database reproducibility
Last synced: 10 months ago
JSON representation
Manage large and heterogeneous data spaces on the file system.
- Host: GitHub
- URL: https://github.com/glotzerlab/signac
- Owner: glotzerlab
- License: bsd-3-clause
- Created: 2019-01-30T23:37:23.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T20:45:52.000Z (11 months ago)
- Last Synced: 2025-04-01T04:51:41.373Z (10 months ago)
- Topics: data, data-management, database, reproducibility
- Language: Python
- Homepage: https://signac.io/
- Size: 7.25 MB
- Stars: 132
- Watchers: 12
- Forks: 36
- Open Issues: 11
-
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
- Governance: governance.md
Awesome Lists containing this project
README
# 
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://signac.readthedocs.io/)
[](https://github.com/glotzerlab/signac/blob/main/LICENSE.txt)
[](https://pypistats.org/packages/signac)
[](https://signac.readthedocs.io/slack-invite/)
[](https://twitter.com/signacdata)
[](https://github.com/glotzerlab/signac/)
The [**signac** framework](https://signac.readthedocs.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://signac.readthedocs.io/):
Examples, tutorials, topic guides, and package Python APIs.
- [Package documentation](https://signac.readthedocs.io/projects/core/):
API reference for the **signac** package.
- [Discussion board](https://github.com/glotzerlab/signac/discussions/):
Ask the **signac** user community for help.
## 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://signac.readthedocs.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://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).