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.
Release files for signac 2.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| signac-2.4.1.tar.gz | 167.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| signac-2.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 302.9 kB
Release files / signac-2.4.1.tar.gz
| Download URL | signac-2.4.1.tar.gz |
|---|---|
| Size | 167.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
509210fe8f870b8c4a9e62ace76e79c39a38d10b12d1e94c141f688a151a79ff
|
|
BLAKE2b-256 checksum How to use checksums |
af3e12b82b89751800f9dced1a134c37adb1987e073650963742d84de7907c63
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Release files / signac-2.4.1-py3-none-any.whl
| Download URL | signac-2.4.1-py3-none-any.whl |
|---|---|
| Size | 135.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f0c5a547cb6fb7b9e5100e9b9678748b0d8275852a7c1214e1e9f41635da229f
|
|
BLAKE2b-256 checksum How to use checksums |
b8418dbf182797f033a0a512b5a1e88417606c5072804b23530a63afcc61f3ce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
