Packages (API)ΒΆ

The signac framework is currently comprised of three packages. You only have to install those that provide the functionality you need, however both signac-flow and signac-dashboard require the signac core package.

The links below lead to the package-specific documentation, including a complete API documentation and changelogs.

signac (core)

The core signac package implements a simple, serverless, distributed database directly on the file system. It allows you manage files on the file system and associate them with JSON-encoded metadata.

This metadata is immediately searchable, which allows you to find and select data for specific data sub spaces.

signac-flow

The signac-flow package allows us to implement workflows that operate on a data space managed with signac. These workflows range from simple, linear workflows, to large workflows with complex dependencies between operations. These workflows can be executed directly on the command line or submitted to a cluster scheduling system, which is relevant for users who work in high-performance computing (HPC) environments.

signac-dashboard

The signac-dashboard allows users to browse their signac-managed data spaces through a web-based GUI. The dashboard can be used for visualization and analysis and is very helpful when sharing data with collaborators.