API Reference

Complete API documentation for the CCAT Workflow Manager. This section provides detailed documentation for developers working with the system.

API Documentation:

• Managers
  • trigger_manager
  • workflow_manager
  • result_manager
• Celery Tasks
  • staging_tasks
  • hpc_tasks
  • result_tasks
• HPC Backends
  • Base
  • Kubernetes
  • SLURM
  • Local
• Grouping & Filter Engine
  • SubGroup
  • FilterEngine
  • Presets
• Command Builder
  • CommandBuilder

Overview

The API is organized into functional areas:

Managers (Managers)

Core orchestration classes: trigger evaluation, workflow dispatch, and result collection. These follow the Manager/Worker pattern described in /source/architecture/manager_worker.

Tasks (Celery Tasks)

Celery task definitions for staging, HPC submission, and result collection.

HPC (HPC Backends)

Abstract backend interface and implementations (SLURM, Kubernetes, Local).

Grouping (Grouping & Filter Engine)

Filter engine, sub-group resolution, and preset templates.

Execution (Command Builder)

Command builder for Apptainer execution and manifest generation.

Architecture Notes

All managers follow the same pattern:

1. Manager Process: Scans database, prepares operations, dispatches work

2. Worker Process: Executes actual work, updates database with results

See /source/architecture/manager_worker for detailed explanation.

For higher-level operational guidance, see:

• /source/concepts/overview - System overview

• /source/concepts/execution_flow - Run lifecycle

• /source/operations/configuration - Configuration reference