Module zoo_calrissian_runner

Sub-modules

• zoo_calrissian_runner.handlers

Classes

CWLWorkflow

class CWLWorkflow(
    cwl,
    workflow_id
)

Static methods

get_resource_requirement

def get_resource_requirement(
    elem
)

Gets the ResourceRequirement out of a CommandLineTool or Workflow

Parameters:

Name	Type	Description	Default
elem	CommandLineTool or Workflow	CommandLineTool or Workflow	None

Returns:

Type	Description
None	cwl_utils.parser.cwl_v1_2.ResourceRequirement or ResourceRequirement

has_scatter_requirement

def has_scatter_requirement(
    workflow
)

Methods

eval_resource

def eval_resource(
    self
)

get_doc

def get_doc(
    self
)

get_label

def get_label(
    self
)

get_object_by_id

def get_object_by_id(
    self,
    id
)

get_version

def get_version(
    self
)

get_workflow

def get_workflow(
    self
) -> cwl_utils.parser.cwl_v1_0.Workflow

get_workflow_inputs

def get_workflow_inputs(
    self,
    mandatory=False
)

ExecutionHandler

class ExecutionHandler(
    **kwargs
)

Extended ExecutionHandler with Calrissian-specific methods.

Inherits from CommonExecutionHandler to provide STAC catalog processing and adds Calrissian/Kubernetes-specific functionality.

Ancestors (in MRO)

• zoo_template_common.common_execution_handler.CommonExecutionHandler
• zoo_runner_common.handlers.ExecutionHandler
• abc.ABC

Static methods

local_get_file

def local_get_file(
    fileName
)

Read and load the contents of a yaml file.

Methods

get_additional_parameters

def get_additional_parameters(
    self
) -> dict[str, str]

Get additional parameters with eoap storage platform.

get_namespace

def get_namespace(
    self
)

Get the namespace for the execution.

get_pod_env_vars

def get_pod_env_vars(
    self
) -> dict[str, str]

Get environment variables for the pod spawned by calrissian.

get_pod_node_selector

def get_pod_node_selector(
    self
) -> dict[str, str]

Get node selector for the pod spawned by calrissian.

get_secrets

def get_secrets(
    self
)

Get secrets for the pod spawned by calrissian.

get_service_account

def get_service_account(
    self
)

Get the service account for the execution.

handle_outputs

def handle_outputs(
    self,
    log,
    output,
    usage_report,
    tool_logs
)

Handle the output files of the execution and register tool logs.

post_execution_hook

def post_execution_hook(
    self,
    log,
    output,
    usage_report,
    tool_logs
)

Hook to run after execution. Sets up S3 environment and processes outputs.

pre_execution_hook

def pre_execution_hook(
    self
)

Hook to run before execution. Override in subclasses for custom behavior.

setOutput

def setOutput(
    self,
    outputName,
    values
)

Process and set output values from STAC catalog.

set_job_id

def set_job_id(
    self,
    job_id
)

Set the job ID for the execution.

ZooConf

class ZooConf(
    conf
)

ZooInputs

class ZooInputs(
    inputs
)

Methods

get_input_value

def get_input_value(
    self,
    key
)

get_processing_parameters

def get_processing_parameters(
    self,
    workflow=None
)

Returns a list with the input parameters keys

Parameters:

Name	Type	Description	Default
workflow	None	Optional CWL workflow object (currently unused, for future compatibility)	None

ZooOutputs

class ZooOutputs(
    outputs
)

Methods

get_output_parameters

def get_output_parameters(
    self
)

Returns a list with the output parameters keys

set_output

def set_output(
    self,
    value
)

set the output result value