signac - simple data management
Resources
Examples, tutorials, topic guides, and package Python APIs. API reference for the signac package. Ask the signac user community for help.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: ``bash
conda install -c conda-forge signac
`
To install signac via pip, execute:
`bash
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:
`bash
$ mkdir my_project
$ cd my_project
$ signac init
`
and access the project handle:
`python
>> project = signac.get_project()
`
Testing
You can test this package by executing:
`bash
$ python -m pytest tests/
``