Reference

A complete reference to all major components of the signac framework.

This section is primarily targeted at users who want to learn in-depth about the individual components. New users should go through the Tutorial first.

Contents:

• Projects
  • Introduction
  • Project Initialization
  • The Data Space
  • Jobs
  • Centralized Project Data
  • Schema Detection
  • Importing and Exporting Data
  • Linked Views
  • Synchronization
• Query API
  • Basics
  • Operator Expressions
  • Simplified Syntax on the Command Line
• Indexing
  • Concept
  • Indexing a signac Project
  • Indexing files
  • Fetching Data
  • Deep Indexing
  • Searching an Index
  • Master Indexes
  • Database Integration
• Collections
  • Creating collections
  • Searching collections
  • Command Line Interface
• Operations and Conditions
  • Data Space Operations
  • Conditions
• The FlowProject
  • Setup and Interface
  • Defining a workflow
  • The Project Status
  • Generating Execution Scripts:
• Cluster Submission
  • The submit interface
  • Submitting specific Operations
  • Parallelization and Bundling
• Manage Environments
  • How to Use Environments
  • Packaged Environments
  • Defining New Environments
  • Contributing Environments to the Package
• Templates
  • Replacing the default template
  • Customize provided templates
  • The base template
  • Execution Directives
• Configuration
  • Overview
  • Project configuration
  • Host configuration