Guides

Follow this path from installation through a first analysis, then use the focused workflow pages for the analysis family your study needs:

1. Installation

2. Quickstart

3. Concepts

4. Typical Workflow

5. Examples

6. API

• Installation
  • Package Install
  • Editable Install
  • Maintainer Shortcut
  • Analysis Extras
• Quickstart
  • 1. Install
  • 2. Minimal Runnable Example
  • 3. What Happened
  • 4. Where To Go Next
  • Ecosystem Note
• Concepts
  • Unified Event Tables
  • Required and Recommended Columns
  • Derivation and Validation
  • Analysis Families
  • Artifacts and Summaries
  • Provenance and Repeatability
• Typical Workflow
  • 1. Choose inputs
  • 2. Instantiate core objects
  • 3. Execute or inspect
  • 4. Capture artifacts
  • 5. Compose the ecosystem seams
  • Choosing Analysis Families
• Workflows
  • Subpages
  • CLI Integration
• Analysis Recipes
  • Sequence Recipe
  • Model Comparison Recipe
  • Language Recipe (Custom Embedder)
  • Embedding Maps Recipe
  • Statistics Recipe
  • Experiment Condition Comparison Recipe
  • Dataset And Provenance Recipe
• Run An Example In VS Code
  • Requirements
  • Installed Package From PyPI
  • Source Checkout For Repository Examples
  • First Development Checks
  • Optional Backends
  • Runtime Caches
  • Troubleshooting