Skip to content
Manage large and heterogeneous data spaces on the file system.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
doc
examples
signac
tests
.bumpversion.cfg
.coveragerc
.deploy.bash
.gitignore
.requirements-deploy.txt
.sync-zenodo-metadata.py
.test-deploy.bash
.zenodo.json
CITATION.cff
CODE_OF_CONDUCT.md
CONTRIBUTING.md
ContributorAgreement.md
LICENSE.txt
README.md
benchmark.py
changelog.txt
contributors.yaml
references.bib
requirements-benchmark.txt
requirements-dev.txt
setup.cfg
setup.py

README.md

signac - simple data management

Affiliated with NumFOCUS PyPI conda-forge CircleCI RTD License PyPI-downloads Gitter

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

Installation

The recommended installation method for signac is through conda or pip. The software is tested for Python versions 2.7 and 3.4+ 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 unittest discover 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.

You can’t perform that action at this time.