Skip to main content

Manage large and heterogeneous data spaces on the file system.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

signac-2.2.0.tar.gz (159.4 kB view hashes)

Uploaded Source

Built Distribution

signac-2.2.0-py3-none-any.whl (129.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page