Skip to content

glotzerlab/signac

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date
Oct 1, 2024
Nov 3, 2022
Jul 30, 2024
Nov 1, 2024
Apr 3, 2024
Jul 31, 2024
Feb 14, 2024
Jan 4, 2023
Dec 23, 2021
Oct 7, 2024
Oct 31, 2021
Feb 14, 2024
Apr 3, 2019
Oct 6, 2023
Feb 29, 2020
Jun 20, 2016
Feb 29, 2020
Feb 12, 2024
Mar 30, 2023
Jul 31, 2024
Feb 12, 2024
Sep 16, 2024
Sep 16, 2024

Repository files navigation

signac - simple data management

Affiliated with NumFOCUS PyPI conda-forge GitHub Actions RTD License PyPI-downloads Slack Twitter GitHub Stars

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 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.