signac - simple data management
The signac framework 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: Examples, tutorials, topic guides, and package Python APIs.
- Package documentation: API reference for the signac package.
- Discussion board: 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 channel, execute:
conda install -c conda-forge signac
To install signac via pip, execute:
pip install signac
Detailed information about alternative installation methods can be found in the documentation.
Quickstart
The framework facilitates a project-based workflow. Set up a new project:
$ mkdir my_project
$ cd my_project
$ signac init
and access the project handle:
>>> project = signac.get_project()
Testing
You can test this package by executing:
$ 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. Thank you very much!
The signac framework is a NumFOCUS Affiliated Project.
Metadata
Release files for signac 2.4.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| signac-2.4.2.tar.gz | 167.1 kB | Without provenance | Details for signac-2.4.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| signac-2.4.2-py3-none-any.whl | Python 3 | none | any | Details for signac-2.4.2-py3-none-any.whl |
Total release size: 301.8 kB
Release files / signac-2.4.2.tar.gz
| Download URL | signac-2.4.2.tar.gz |
|---|---|
| Size | 167.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d64bfb9633ae36721d626df07efc77439ead9e0bfd52d919f42b66f8f794348f
|
|
BLAKE2b-256 checksum How to use checksums |
d24bddab1f8ccb3192cd7e8eeec44eef31487c788bb189bbbb302d47abc51b4c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / signac-2.4.2-py3-none-any.whl
| Download URL | signac-2.4.2-py3-none-any.whl |
|---|---|
| Size | 134.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3b5cd02cf0386b2ce08722cee06263a1201ad87b3c56a516773a6297a99c8fd3
|
|
BLAKE2b-256 checksum How to use checksums |
26787e1fe6bb74053e75980884252a8c35c8bbc0abea18068d00315c6e087c13
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for signac 2.4.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.