Manage large and heterogeneous data spaces on the file system.
Project description
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.
- Slack Chat Support: Get help and ask questions on the signac Slack workspace.
- signac website: 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 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 MyProject
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 history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file signac-1.8.0.tar.gz.
File metadata
- Download URL: signac-1.8.0.tar.gz
- Upload date:
- Size: 202.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fff800147caaab5cf40ffd2a39c1ae500684071a4219613a1d039feb852ff33f |
|
| MD5 | 8015d2b44bef9f20610762e9179937a6 |
|
| BLAKE2b-256 | ac0983383b026a2b61c869f97a20e6c65f197c4ed5ba6cae53a9663de9a4e3a1 |
Provenance
File details
Details for the file signac-1.8.0-py3-none-any.whl.
File metadata
- Download URL: signac-1.8.0-py3-none-any.whl
- Upload date:
- Size: 241.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8af83c6eea636c0fdb887cee4e91be2065fc91c1d46041ce14c9b19b8b713820 |
|
| MD5 | 3c16ac1c63b0786c3613b1a00a2e1ef1 |
|
| BLAKE2b-256 | 7ee63949cd47c5471df856c515a41e58661257c8b632a8c3d9d094983a3c3b7b |
