ogdc_runner.publish module

Code for interacting with and publishing outputs of OGDC recipes

ogdc_runner.publish.check_for_existing_published_data(*, recipe_config: RecipeConfig) bool

Execute argo workflow that checks if the given recipe has published data.

Returns True if data have already been published for the given recipe, otherwise False.

Parameters:

recipe_config (RecipeConfig)

Return type:

bool

ogdc_runner.publish.check_for_existing_pvc_published_data(*, recipe_config: RecipeConfig) bool

Execute argo workflow that checks if the given recipe has published data to PVC.

Returns True if data have already been published for the given recipe, otherwise False.

Parameters:

recipe_config (RecipeConfig)

Return type:

bool

ogdc_runner.publish.data_already_published(*, recipe_config: RecipeConfig, overwrite: bool) bool

Check for the existence of published data for the given recipe and optionally remove it.

If overwrite=True, this function will remove any existing published data for the provided recipe.

Returns True if data have already been published for the given recipe, otherwise False.

Parameters:
Return type:

bool

ogdc_runner.publish.get_temporary_output_data_url(*, workflow_name: str) str

Return the s3 URL for the temporary published output.

Raises an OgdcOutputDataRetrievalError if the published output is not found.

Parameters:

workflow_name (str)

Return type:

str

ogdc_runner.publish.make_publish_template(*, recipe_config: RecipeConfig) hera.workflows.Container

Creates a container template that will publish final output data.

Parameters:

recipe_config (RecipeConfig)

Return type:

Container

ogdc_runner.publish.remove_existing_published_data(*, recipe_config: RecipeConfig) None

Executes an argo workflow that removes published data for a recipe if it exists.

Parameters:

recipe_config (RecipeConfig)

Return type:

None