API Reference

The API reference documentation is currently being updated to reflect the latest OpenHCS architecture and remove outdated content.

For now, please refer to:

Core Concepts: Core Concepts

Understanding pipelines, steps, function patterns, and system architecture

Getting Started: Introduction to OpenHCS

Basic examples and common usage patterns

Function Library: Function Library

Available processing functions and library integrations

Key Classes

PipelineOrchestrator

from openhcs.core.orchestrator.orchestrator import PipelineOrchestrator
from openhcs.core.config import GlobalPipelineConfig
from openhcs.core.lazy_config import ensure_global_config_context

# Set global context first (done at application startup)
config = GlobalPipelineConfig(num_workers=4)
ensure_global_config_context(GlobalPipelineConfig, config)

# Create orchestrator with simplified constructor
orchestrator = PipelineOrchestrator(plate_path="/path/to/data")

FunctionStep

from openhcs.core.steps.function_step import FunctionStep
from openhcs.constants.constants import VariableComponents

step = FunctionStep(
    func=(processing_function, {'param': value}),
    variable_components=[VariableComponents.SITE],
    name="step_name"
)

Pipeline

from openhcs.core.pipeline import Pipeline

pipeline = Pipeline([step1, step2, step3])
orchestrator.run_pipeline(pipeline)

The complete API reference will be restored with updated examples and correct module paths.