Simple file data management database.
signac - simple data management
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 documentation is available at: https://signac.readthedocs.io
The framework documentation is available at: https://signac-docs.readthedocs.io
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.
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.
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()
The documentation for this package is hosted at https://signac.readthedocs.io. We further invite you to check out the framework documentation, which provides a more comprehensive overview over all components of the framework.
You can test this package either by executing
$ python -m unittest discover tests/
within the repository root directory or with tox.
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!