ska_sdp_e2e_batch_continuum_imaging.pipelines.models.sdp.batch_e2e_pipeline_config module

Following models are copied from "batch_e2e_pipeline_config.py" module from ska-sdp-script/src/ska-sdp-script-continuum-imaging/models package. If these model change in above package, then we must copy them here to ensure correct validations.

ContinuumImagingParams are used from continuum_imaging_params module in current package.

pydantic model ska_sdp_e2e_batch_continuum_imaging.pipelines.models.sdp.batch_e2e_pipeline_config.SDPMetadataConfig[source]

Bases: BaseModel

Information to be filled in to the "config" section of the SDP dataproduct metdata file

Config:

  • strict: bool = False

  • extra: str = ignore

  • arbitrary_types_allowed: bool = False

  • validate_assignment: bool = True

  • validate_default: bool = True

  • use_attribute_docstrings: bool = True

Fields:
field cmdline: str | None = None

CLI command

field commit: str | None = None

Commit hash of the processing script

field image: str [Required]

OCI Image of the processing script

field processing_block: Annotated[str] [Required]

ID of the Processing Block corresponding to batch e2e pipeline

Constraints:

  • pattern = ^pb-[a-z0-9]+-[0-9]{8}-[a-z0-9]+$

field processing_script: str [Required]

Name of the processing script

field version: str [Required]

Version of the processing script

pydantic model ska_sdp_e2e_batch_continuum_imaging.pipelines.models.sdp.batch_e2e_pipeline_config.SDPBatchE2EPipelineConfig[source]

Bases: BaseModel

Configuration as expected by the run-from-sdp subcommand of ska-sdp-batch-e2e-pipeline.

Config:

  • strict: bool = False

  • extra: str = ignore

  • arbitrary_types_allowed: bool = False

  • validate_assignment: bool = True

  • validate_default: bool = True

  • use_attribute_docstrings: bool = True

Fields:
field cold_buffer_path: Annotated[Path] [Required]

cold buffer path till root of sdp data models

field eb_id: Annotated[str] [Required]

ID of the Execution Block

Constraints:

  • pattern = ^eb-[a-z0-9]+-[0-9]{8}-[a-z0-9]+$

field hot_buffer_path: Annotated[Path] [Required]

hot buffer path till root of sdp data models

field parameters: Annotated[ContinuumImagingParams] [Optional]

Pipeline parameters

field sdp_metadata_config: Annotated[SDPMetadataConfig] [Required]

The information needed to fill in the "config" section of the SDP metadata

field upstream_sdm_path: Annotated[Path] [Required]

Path to the upstream SDM

field visibility_subpaths: Annotated[List[Path]] [Required]

List of visibility subpaths. It should be relative to buffer_path