fre.pp.run_script module

fre pp run

fre.pp.run_script.pp_run_subtool(experiment=None, platform=None, target=None, pause=False, no_wait=False)

Starts, pauses or restarts the Cylc workflow described by $(experiment)__$(platform)__$(target)

Parameters:

• experiment (str) – One of the postprocessing experiment names from the yaml displayed by fre list exps -y $yamlfile (e.g. c96L65_am5f4b4r0_amip), default None

• platform (str) – The location + compiler that was used to run the model (e.g. gfdl.ncrc5-deploy), default None

• target (str) – Options used for the model compiler (e.g. prod-openmp), default None

• pause (boolean) – Whether to pause the current Cylc workflow. Defaults to false, which starts or restarts the workflow.

• no_wait (boolean) – Whether to avoid waiting at least 30 seconds for confirmation that the workflow is stopped. Defaults to False, which waits for confirmation.