signac - a simple data management framework

About

The signac framework aids in the management of large and heterogeneous data spaces.

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.

The package's documentation is available at: http://signac.readthedocs.io

Installation

The recommendend installation method for signac is through conda or pip. The software is tested for python versions 2.7.x and 3.x and is built for all major platforms.

Install via conda

Installing signac from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge

Once the conda-forge channel has been enabled, signac can be installed with:

conda install signac

Install via pip

To install signac via pip, execute:

pip install --user signac

Detailed information about alternative installation methods and configuration of this package can be found in the documentation.

Quickstart

The framework facilitates a project-based workflow. Setup a new project:

$ mkdir my_project
$ cd my_project
$ signac init MyProject

and access the project handle:

>>> project = signac.get_project()

Documentation

The documentation is available online at https://signac.readthedocs.io. We further invite you to check out the collection of Jupyter notebooks hosted on mybinder.org, which serve both as tutorial and examples collection.

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!