fre.pp.trigger_script module

fre pp trigger

fre.pp.trigger_script.trigger(experiment=None, platform=None, target=None, time=None)

Trigger the postprocessing tasks for one segment of the history.

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

• time (Cylc representation of a time point) – The start time of the segment. Formatted as a series of integers.

Note

The segment is defined as a start point (–time) and a duration (defined in the experiment yaml). Cylc combines the two for a cycle duration; we are using datetime cycling (https://cylc.github.io/cylc-doc/stable/html/glossary.html#term-datetime-cycling) for FRE. Historically, the start point has often been formatted YYYYMMDD and is the first chunk of a filename (19790101.atmos_tracer.tile6.nc).