From 875fb6b8eddd2aa9774ca1fa9fe319a0abdf9ef3 Mon Sep 17 00:00:00 2001 From: James Frost Date: Tue, 30 Jul 2024 15:54:07 +0100 Subject: [PATCH] Add multiple models to rose edit configuration Also gone through and removed some unneeded things, added titles, etc. Still need to go through the diagnostics. --- cset-workflow/meta/rose-meta.conf | 1120 ++++++++++++++++++++++++++--- 1 file changed, 1019 insertions(+), 101 deletions(-) diff --git a/cset-workflow/meta/rose-meta.conf b/cset-workflow/meta/rose-meta.conf index f25dee067..cc360f799 100644 --- a/cset-workflow/meta/rose-meta.conf +++ b/cset-workflow/meta/rose-meta.conf @@ -1,4 +1,4 @@ -# Workflow's configuration metadata +# Workflow’s configuration metadata [template variables] ################################################################################ @@ -7,6 +7,7 @@ [template variables=SITE] ns=Environment +title=Site description=Which institution to load the site-specific configuration for. help=The site-specific configuration should live in a file under site/ For example the Met Office configuration lives under "site/metoffice.cylc". @@ -30,6 +31,7 @@ sort-key=modules1 [template variables=MODULES_PURGE] ns=Environment +title=Purge modules description=Purge modules that are not explicitly specified. help=Remove any modules that are loaded by default before loading the specified ones. This is recommended as it makes your workflows more explicit and less @@ -58,6 +60,7 @@ sort-key=conda1 [template variables=CONDA_PATH] ns=Environment +title=Conda executable path description=Where to get conda from. Leave blank if conda already on path. help=Path where the conda executable is. This should be to a directory, rather to a binary itself. Leave this field blank if conda comes from another @@ -67,6 +70,7 @@ sort-key=conda2 [template variables=CONDA_VENV_CREATE] ns=Environment +title=Create conda environment description=Whether to (re)create the conda environment. help=When enabled it will check that the conda environment exists and is up-to-date, recreating it otherwise. @@ -75,15 +79,21 @@ sort-key=conda2 [template variables=CONDA_VENV_LOCATION] ns=Environment +title=Conda environment location description=Location of the conda virtual environment. -help=The can be found by running `conda env list` and copying the path displayed - there. If unspecified it defaults to the workflow share directory. +help=Existing environments can be found by running `conda info --envs` and + copying the path displayed there. If unspecified it defaults to the workflow + share directory. + + If creating the conda environment as part of the workflow, it will only be + created if it does not exist or is out of date. type=quoted sort-key=conda2 [template variables=CSET_ENV_USE_LOCAL_CSET] ns=Environment -description=Whether to use a local version of CSET +title=Use local CSET +description=Whether to use a local version of CSET, rather than the bundled one. help=Use a local version of CSET, rather than the version provided from conda. This is especially useful for running development versions. type=python_boolean @@ -93,6 +103,7 @@ sort-key=localcset1 [template variables=CSET_LOCAL_CSET_PATH] ns=Environment +title=Local CSET path description=Path to local copy of CSET. help=Path to either a wheel file, or a checked out copy of the CSET git repo. For the repository, it should be the path to the directory containing the @@ -150,6 +161,7 @@ compulsory=true [template variables=HOUSEKEEPING_MODE] ns=General +title=Housekeeping mode description=How much housekeeping deletes. help=None will delete nothing. @@ -171,150 +183,1054 @@ help= type=quoted compulsory=true -[template variables=WEB_DIR] -ns=General -description=Path to directory that is served by the webserver. -help=This will probably be under $HOME/public_html or similar. You will want to - ensure a subfolder is used as multiple files will be written here. -type=quoted -compulsory=true -sort-key=web2 - [template variables=WEB_ADDR] ns=General description=The address at which the website is served. help=This should be the address where your public_html or equivalent is served. It might include a partial path, such as your username. + + E.g: https://example.com/~username/ type=quoted compulsory=true sort-key=web1 +[template variables=WEB_DIR] +ns=General +title=Web directory +description=Path to directory that is served by the webserver. +help=This will probably be under $HOME/public_html or similar. You will want to + ensure a subfolder is used as multiple files will be written here. + + This is where the output of the workflow will be accessible from, through a + symlink to the workflow shared directory. The directory will be created if + needed. + + E.g: $HOME/public_html/CSET +type=quoted +compulsory=true +sort-key=web2 + [template variables=CLEAN_WEB_DIR] ns=General -description=Delete existing output in WEB_DIR. +title=Overwrite existing output +description=Delete existing output in WEB_DIR on workflow startup. help=Whether to remove any existing files in WEB_DIR before running CSET. CSET will not overwrite files, so if this is not set the workflow will stop on - encountering pre-existing files. + encountering pre-existing files, to prevent data loss. type=python_boolean compulsory=true sort-key=web3 [template variables=CSET_RUNAHEAD_LIMIT] ns=General +title=Concurrent cycle limit description=Number of simultaneous cycles. help=The maximum number of cycles run in parallel. A larger number here will finish quicker, but utilise more compute resources at once. For a large enough workflow it may overwhelm the batch submission system, so it is - recommended to keep this below 10. Must be positive. + recommended to keep this below 10. type=integer +range=0: compulsory=true ################################################################################ -# Data and Cycling +# Models and Cases ################################################################################ +[template variables=CSET_CYCLING_MODE] +ns=Models and Cases +title=Cycling mode +description=Process case studies, or a continuous trial. +values=Case Study, Trial +trigger=template variables=CSET_CASE_DATES: Case Study; + template variables=CSET_TRIAL_START_DATE: Trial; + template variables=CSET_TRIAL_END_DATE: Trial; + template variables=CSET_TRIAL_CYCLE_PERIOD: Trial; +compulsory=true +sort-key=a1 + +# Case study settings. [template variables=CSET_CASE_DATES] -ns=Data and Cycling +ns=Models and Cases +title=Case study dates description=List of datetimes of cases. help=This should be a python list of ISO 8601 datetime strings indicating the - forecast initiation time (AKA data time) of the data. E.g. 2000-01-01T00:00Z. - Ensure that it is consistent with your data's first validity time. If not + forecast initiation time (AKA data time) of the data. E.g. 2000-01-01T00:00Z + Ensure that it is consistent with your data’s first validity time. If not then a warning that cubes can not be loaded is raised. type=python_list compulsory=true -sort-key=cycle1 +sort-key=b1 + +# Trials settings. +[template variables=CSET_TRIAL_START_DATE] +ns=Models and Cases +title=Trial start date +description=Start date of the trial. +help=The start date of the trial, in ISO 8601 format. This is the first date + that the workflow will run from. For example: 2000-01-01T00:00Z +type=quoted +compulsory=true +sort-key=c1 + +[template variables=CSET_TRIAL_END_DATE] +ns=Models and Cases +title=Trial end date +description=End date of the trial. If blank, the workflow will run indefinitely. +help=The end date of the trial, in ISO 8601 format. This is the last date that + the workflow will run to. If blank, the workflow will run indefinitely. + For example: 2000-01-01T00:00Z +type=quoted +compulsory=true +sort-key=c2 + +[template variables=CSET_TRIAL_CYCLE_PERIOD] +ns=Models and Cases +title=Trial cycle period +description=The period between model runs of the trial. +help=The cycle period of the trial, as an ISO 8601 duration. This is the time + between each forecast initiation of the model. For example: PT48H +type=quoted +compulsory=true +sort-key=c3 + +[template variables=CSET_VERIFICATION_PERIOD] +ns=Models and Cases +title=Verification period +description=The period over which to verify the forecast, AKA forecast length. +help=The period over which to verify the forecast, in ISO 8601 duration format. + For example: PT48H +type=quoted +compulsory=true +sort-key=d1 + +[template variables=CSET_VERIFICATION_OFFSET] +ns=Models and Cases +title=Verification offset +description=Offset from forecast initiation to verification start. +help=The offset in time between the forecast initiation and the start of the + verification period. This is useful when needed fields are not output on the + first time step. For example: PT1H +type=quoted +compulsory=true +sort-key=d2 + +[template variables=CSET_MODEL_COUNT] +ns=Models and Cases +title=Number of models +description=Number of models to evaluate. +help=The number of models to evaluate, between 1 and 10. If more models + are needed, it is straightforward to change upon request. +type=integer +range=1:10 +compulsory=true +sort-key=e1 +# Need to link to all of the model settings here. +trigger=template variables=m01_data_source: this >= 1; + template variables=m01_data_path: this >= 1; + template variables=m01_date_type: this >= 1; + template variables=m01_lead_time_forecast_initiation_time: this >= 1; + template variables=m01_preprocessing: this >= 1; + template variables=m01_preprocessing_recipe: this >= 1; + template variables=m02_data_source: this >= 2; + template variables=m02_data_path: this >= 2; + template variables=m02_date_type: this >= 2; + template variables=m02_lead_time_forecast_initiation_time: this >= 2; + template variables=m02_preprocessing: this >= 2; + template variables=m02_preprocessing_recipe: this >= 2; + + +################################################################################ +# Model definitions. Repeat section for each desired model. +################################################################################ + +# # Model ?? +# [template variables=m??_data_source] +# ns=Models and Cases/Model ?? +# title=Data source +# description=From whence to retrieve the forecast. +# help=System from which to retrieve the forecast data. Filesystem is generic, +# while the others are site-specific. +# values="filesystem", "mass" +# value-titles=Filesystem, MASS +# compulsory=true +# sort-key=a1 + +# [template variables=m??_data_path] +# ns=Models and Cases/Model ?? +# title=Data path +# description=The path to the forecast. +# help=Full path (including file name) to the forecast data on your chosen storage +# system. Can contain wildcards. No quotation marks required in rose edit, as +# it is already quoted there. + +# strftime format strings are supported, and will be replaced with the +# desired case study date or trial time. E.g: `/data/%Y%m%d/model1/*.nc` + +# For more on strftime format strings, see: https://strftime.org/ +# type=quoted +# compulsory=true +# sort-key=a2 + +# [template variables=m??_date_type] +# ns=Models and Cases/Model ?? +# title=Date placeholder type +# description=Type of date templated into the data path. +# help=The type of date templated into the data path. Affects interpretation of +# strftime placeholders in the data path. + +# Validity time is when the data is predicting for. + +# Forecast initiation time, AKA data time, is the time of the validity time of +# the first data point. For realtime forecasts this is approximately when the +# forecast was started. + +# Forecast lead time is how far from the forecast initiation time the data is. +# values=validity, initiation, lead +# value-titles=Validity Time, Forecast Initiation Time, Forecast Lead Time +# compulsory=true +# trigger=template variables=m??_lead_time_forecast_initiation_time: lead; +# sort-key=b1 + +# [template variables=m??_lead_time_forecast_initiation_time] +# ns=Models and Cases/Model ?? +# title=Forecast initiation time +# description=The initiation time from which the lead time is calculated. +# help=The initiation time from which the lead time is calculated as an ISO 8601 +# datetime. E.g: 2000-01-01T00:00Z +# type=quoted +# compulsory=true +# sort-key=b2 + +# [template variables=m??_preprocessing] +# ns=Models and Cases/Model ?? +# title=Preprocess +# description=Preprocess all of the model data. +# help=Whether to preprocess all of the model data. This is useful for applying +# any necessary transformations to the data before it is used in the workflow, +# such as removing boundary regions. +# type=python_boolean +# compulsory=true +# trigger=template variables=m??_preprocessing_recipe: True; +# sort-key=c1 + +# [template variables=m??_preprocessing_recipe] +# ns=Models and Cases/Model ?? +# title=Preprocessing recipe +# description=The preprocessing recipe to use. NOTE: Not yet implemented. +# help=The preprocessing recipe to use. +# type=quoted +# compulsory=true +# sort-key=c2 + + +# Model 01 +[template variables=m01_data_source] +ns=Models and Cases/Model 01 +title=Data source +description=From whence to retrieve the forecast. +help=System from which to retrieve the forecast data. Filesystem is generic, + while the others are site-specific. +values="filesystem", "mass" +value-titles=Filesystem, MASS +compulsory=true +sort-key=a1 -[template variables=CSET_CASE_PATHS] -ns=Data and Cycling -description=Lists of data paths of cases. -help=Python list of data locations for the case data as strings. The order should - match that of CSET_CASE_DATES. -type=python lists +[template variables=m01_data_path] +ns=Models and Cases/Model 01 +title=Data path +description=The path to the forecast. +help=Full path (including file name) to the forecast data on your chosen storage + system. Can contain wildcards. No quotation marks required in rose edit, as + it is already quoted there. + + strftime format strings are supported, and will be replaced with the + desired case study date or trial time. E.g: `/data/%Y%m%d/model1/*.nc` + + For more on strftime format strings, see: https://strftime.org/ +type=quoted compulsory=true -sort-key=cycle1 +sort-key=a2 -# Input data settings. -[template variables=FETCH_FCST_OPT_CONF] -ns=Data and Cycling +[template variables=m01_date_type] +ns=Models and Cases/Model 01 +title=Date placeholder type +description=Type of date templated into the data path. +help=The type of date templated into the data path. Affects interpretation of + strftime placeholders in the data path. + + Validity time is when the data is predicting for. + + Forecast initiation time, AKA data time, is the time of the validity time of + the first data point. For realtime forecasts this is approximately when the + forecast was started. + + Forecast lead time is how far from the forecast initiation time the data is. +values=validity, initiation, lead +value-titles=Validity Time, Forecast Initiation Time, Forecast Lead Time +compulsory=true +trigger=template variables=m01_lead_time_forecast_initiation_time: lead; +sort-key=b1 + +[template variables=m01_lead_time_forecast_initiation_time] +ns=Models and Cases/Model 01 +title=Forecast initiation time +description=The initiation time from which the lead time is calculated. +help=The initiation time from which the lead time is calculated as an ISO 8601 + datetime. E.g: 2000-01-01T00:00Z +type=quoted +compulsory=true +sort-key=b2 + +[template variables=m01_preprocessing] +ns=Models and Cases/Model 01 +title=Preprocess +description=Preprocess all of the model data. +help=Whether to preprocess all of the model data. This is useful for applying + any necessary transformations to the data before it is used in the workflow, + such as removing boundary regions. +type=python_boolean +compulsory=true +trigger=template variables=m01_preprocessing_recipe: True; +sort-key=c1 + +[template variables=m01_preprocessing_recipe] +ns=Models and Cases/Model 01 +title=Preprocessing recipe +description=The preprocessing recipe to use. NOTE: Not yet implemented. +help=The preprocessing recipe to use. +type=quoted +compulsory=true +sort-key=c2 + + +# Model 02 +[template variables=m02_data_source] +ns=Models and Cases/Model 02 +title=Data source description=From whence to retrieve the forecast. help=System from which to retrieve the forecast data. Filesystem is generic, while the others are site-specific. values="filesystem", "mass" value-titles=Filesystem, MASS compulsory=true -sort-key=input1 +sort-key=a1 -[template variables=CSET_INPUT_FILE_PATH] -ns=Data and Cycling +[template variables=m02_data_path] +ns=Models and Cases/Model 02 +title=Data path description=The path to the forecast. help=Full path (including file name) to the forecast data on your chosen storage - system. Can contain wildcards. No quotation marks required. -type=quoted -compulsory=true -sort-key=input2 - -[template variables=CSET_INCREMENTAL_DATA_FETCH] -ns=Data and Cycling -description=Collect only the needed input files for each time step. -help=Whether to collect input data only when it is needed. This requires some - additional setup, so is only recommended when your input data is large - relative to your disk space. -type=python_boolean -trigger=template variables=CSET_FILE_NAME_METADATA_PATTERN: True; - template variables=CSET_TIMES_PER_FILE: True; - template variables=CSET_FILE_TIME_OFFSET: True; -compulsory=true -sort-key=incr_in1 - -[template variables=CSET_FILE_NAME_METADATA_PATTERN] -ns=Data and Cycling -description=Template string identifying the metadata within the filename. -help=The pattern format is the filename with a number of placeholders added to - mark where the time information is. You must have enough information to - get the validity time, either directly from the validity time, or derived - from the initiation time and lead time. Placeholders marked with † are optional. - - Validity time placeholders: - * ``{valid_year}`` - * ``{valid_month}`` - * ``{valid_word_month}`` - * ``{valid_day}`` - * ``{valid_hour}``† - * ``{valid_minute}``† - - Initiation time placeholders: - * ``{init_year}`` - * ``{init_month}`` Numeric month, e.g: 02 - * ``{init_word_month}`` Wordy month, e.g: feb - * ``{init_day}`` - * ``{init_hour}``† - * ``{init_minute}``† - * ``{lead_hour}`` -type=quoted -compulsory=true -sort-key=incr_in2 - -[template variables=CSET_TIMES_PER_FILE] -ns=Data and Cycling -description=Number of cycle periods in each file. -help=The number of cycle periods (as defined by CSET_CYCLE_PERIOD) within each input - file. Normally this will be the number of timesteps per file. -type=integer + system. Can contain wildcards. No quotation marks required in rose edit, as + it is already quoted there. + + strftime format strings are supported, and will be replaced with the + desired case study date or trial time. E.g: `/data/%Y%m%d/model1/*.nc` + + For more on strftime format strings, see: https://strftime.org/ +type=quoted compulsory=true -sort-key=incr_in2 +sort-key=a2 -[template variables=CSET_FILE_TIME_OFFSET] -ns=Data and Cycling -description=Offset between filename time and data time. -help=Indicates the offset in time periods between the marked validity time - and the earliest time in the file. +[template variables=m02_date_type] +ns=Models and Cases/Model 02 +title=Date placeholder type +description=Type of date templated into the data path. +help=The type of date templated into the data path. Affects interpretation of + strftime placeholders in the data path. - E.g. if the filename time was 06:00, then +2 would mean the first contained - time was 04:00, while -2 would mean the first time was 08:00. -type=integer + Validity time is when the data is predicting for. + + Forecast initiation time, AKA data time, is the time of the validity time of + the first data point. For realtime forecasts this is approximately when the + forecast was started. + + Forecast lead time is how far from the forecast initiation time the data is. +values=validity, initiation, lead +value-titles=Validity Time, Forecast Initiation Time, Forecast Lead Time +compulsory=true +trigger=template variables=m02_lead_time_forecast_initiation_time: lead; +sort-key=b1 + +[template variables=m02_lead_time_forecast_initiation_time] +ns=Models and Cases/Model 02 +title=Forecast initiation time +description=The initiation time from which the lead time is calculated. +help=The initiation time from which the lead time is calculated as an ISO 8601 + datetime. E.g: 2000-01-01T00:00Z +type=quoted compulsory=true -sort-key=incr_in2 +sort-key=b2 + +[template variables=m02_preprocessing] +ns=Models and Cases/Model 02 +title=Preprocess +description=Preprocess all of the model data. +help=Whether to preprocess all of the model data. This is useful for applying + any necessary transformations to the data before it is used in the workflow, + such as removing boundary regions. +type=python_boolean +compulsory=true +trigger=template variables=m02_preprocessing_recipe: True; +sort-key=c1 + +[template variables=m02_preprocessing_recipe] +ns=Models and Cases/Model 02 +title=Preprocessing recipe +description=The preprocessing recipe to use. NOTE: Not yet implemented. +help=The preprocessing recipe to use. +type=quoted +compulsory=true +sort-key=c2 + + +# Model 03 +[template variables=m03_data_source] +ns=Models and Cases/Model 03 +title=Data source +description=From whence to retrieve the forecast. +help=System from which to retrieve the forecast data. Filesystem is generic, + while the others are site-specific. +values="filesystem", "mass" +value-titles=Filesystem, MASS +compulsory=true +sort-key=a1 + +[template variables=m03_data_path] +ns=Models and Cases/Model 03 +title=Data path +description=The path to the forecast. +help=Full path (including file name) to the forecast data on your chosen storage + system. Can contain wildcards. No quotation marks required in rose edit, as + it is already quoted there. + + strftime format strings are supported, and will be replaced with the + desired case study date or trial time. E.g: `/data/%Y%m%d/model1/*.nc` + + For more on strftime format strings, see: https://strftime.org/ +type=quoted +compulsory=true +sort-key=a2 + +[template variables=m03_date_type] +ns=Models and Cases/Model 03 +title=Date placeholder type +description=Type of date templated into the data path. +help=The type of date templated into the data path. Affects interpretation of + strftime placeholders in the data path. + + Validity time is when the data is predicting for. + + Forecast initiation time, AKA data time, is the time of the validity time of + the first data point. For realtime forecasts this is approximately when the + forecast was started. + + Forecast lead time is how far from the forecast initiation time the data is. +values=validity, initiation, lead +value-titles=Validity Time, Forecast Initiation Time, Forecast Lead Time +compulsory=true +trigger=template variables=m03_lead_time_forecast_initiation_time: lead; +sort-key=b1 + +[template variables=m03_lead_time_forecast_initiation_time] +ns=Models and Cases/Model 03 +title=Forecast initiation time +description=The initiation time from which the lead time is calculated. +help=The initiation time from which the lead time is calculated as an ISO 8601 + datetime. E.g: 2000-01-01T00:00Z +type=quoted +compulsory=true +sort-key=b2 + +[template variables=m03_preprocessing] +ns=Models and Cases/Model 03 +title=Preprocess +description=Preprocess all of the model data. +help=Whether to preprocess all of the model data. This is useful for applying + any necessary transformations to the data before it is used in the workflow, + such as removing boundary regions. +type=python_boolean +compulsory=true +trigger=template variables=m03_preprocessing_recipe: True; +sort-key=c1 + +[template variables=m03_preprocessing_recipe] +ns=Models and Cases/Model 03 +title=Preprocessing recipe +description=The preprocessing recipe to use. NOTE: Not yet implemented. +help=The preprocessing recipe to use. +type=quoted +compulsory=true +sort-key=c2 + + + +# Model 04 +[template variables=m04_data_source] +ns=Models and Cases/Model 04 +title=Data source +description=From whence to retrieve the forecast. +help=System from which to retrieve the forecast data. Filesystem is generic, + while the others are site-specific. +values="filesystem", "mass" +value-titles=Filesystem, MASS +compulsory=true +sort-key=a1 + +[template variables=m04_data_path] +ns=Models and Cases/Model 04 +title=Data path +description=The path to the forecast. +help=Full path (including file name) to the forecast data on your chosen storage + system. Can contain wildcards. No quotation marks required in rose edit, as + it is already quoted there. + + strftime format strings are supported, and will be replaced with the + desired case study date or trial time. E.g: `/data/%Y%m%d/model1/*.nc` + + For more on strftime format strings, see: https://strftime.org/ +type=quoted +compulsory=true +sort-key=a2 + +[template variables=m04_date_type] +ns=Models and Cases/Model 04 +title=Date placeholder type +description=Type of date templated into the data path. +help=The type of date templated into the data path. Affects interpretation of + strftime placeholders in the data path. + + Validity time is when the data is predicting for. + + Forecast initiation time, AKA data time, is the time of the validity time of + the first data point. For realtime forecasts this is approximately when the + forecast was started. + + Forecast lead time is how far from the forecast initiation time the data is. +values=validity, initiation, lead +value-titles=Validity Time, Forecast Initiation Time, Forecast Lead Time +compulsory=true +trigger=template variables=m04_lead_time_forecast_initiation_time: lead; +sort-key=b1 + +[template variables=m04_lead_time_forecast_initiation_time] +ns=Models and Cases/Model 04 +title=Forecast initiation time +description=The initiation time from which the lead time is calculated. +help=The initiation time from which the lead time is calculated as an ISO 8601 + datetime. E.g: 2000-01-01T00:00Z +type=quoted +compulsory=true +sort-key=b2 + +[template variables=m04_preprocessing] +ns=Models and Cases/Model 04 +title=Preprocess +description=Preprocess all of the model data. +help=Whether to preprocess all of the model data. This is useful for applying + any necessary transformations to the data before it is used in the workflow, + such as removing boundary regions. +type=python_boolean +compulsory=true +trigger=template variables=m04_preprocessing_recipe: True; +sort-key=c1 + +[template variables=m04_preprocessing_recipe] +ns=Models and Cases/Model 04 +title=Preprocessing recipe +description=The preprocessing recipe to use. NOTE: Not yet implemented. +help=The preprocessing recipe to use. +type=quoted +compulsory=true +sort-key=c2 + + + +# Model 05 +[template variables=m05_data_source] +ns=Models and Cases/Model 05 +title=Data source +description=From whence to retrieve the forecast. +help=System from which to retrieve the forecast data. Filesystem is generic, + while the others are site-specific. +values="filesystem", "mass" +value-titles=Filesystem, MASS +compulsory=true +sort-key=a1 + +[template variables=m05_data_path] +ns=Models and Cases/Model 05 +title=Data path +description=The path to the forecast. +help=Full path (including file name) to the forecast data on your chosen storage + system. Can contain wildcards. No quotation marks required in rose edit, as + it is already quoted there. + + strftime format strings are supported, and will be replaced with the + desired case study date or trial time. E.g: `/data/%Y%m%d/model1/*.nc` + + For more on strftime format strings, see: https://strftime.org/ +type=quoted +compulsory=true +sort-key=a2 + +[template variables=m05_date_type] +ns=Models and Cases/Model 05 +title=Date placeholder type +description=Type of date templated into the data path. +help=The type of date templated into the data path. Affects interpretation of + strftime placeholders in the data path. + + Validity time is when the data is predicting for. + + Forecast initiation time, AKA data time, is the time of the validity time of + the first data point. For realtime forecasts this is approximately when the + forecast was started. + + Forecast lead time is how far from the forecast initiation time the data is. +values=validity, initiation, lead +value-titles=Validity Time, Forecast Initiation Time, Forecast Lead Time +compulsory=true +trigger=template variables=m05_lead_time_forecast_initiation_time: lead; +sort-key=b1 + +[template variables=m05_lead_time_forecast_initiation_time] +ns=Models and Cases/Model 05 +title=Forecast initiation time +description=The initiation time from which the lead time is calculated. +help=The initiation time from which the lead time is calculated as an ISO 8601 + datetime. E.g: 2000-01-01T00:00Z +type=quoted +compulsory=true +sort-key=b2 + +[template variables=m05_preprocessing] +ns=Models and Cases/Model 05 +title=Preprocess +description=Preprocess all of the model data. +help=Whether to preprocess all of the model data. This is useful for applying + any necessary transformations to the data before it is used in the workflow, + such as removing boundary regions. +type=python_boolean +compulsory=true +trigger=template variables=m05_preprocessing_recipe: True; +sort-key=c1 + +[template variables=m05_preprocessing_recipe] +ns=Models and Cases/Model 05 +title=Preprocessing recipe +description=The preprocessing recipe to use. NOTE: Not yet implemented. +help=The preprocessing recipe to use. +type=quoted +compulsory=true +sort-key=c2 + + + +# Model 06 +[template variables=m06_data_source] +ns=Models and Cases/Model 06 +title=Data source +description=From whence to retrieve the forecast. +help=System from which to retrieve the forecast data. Filesystem is generic, + while the others are site-specific. +values="filesystem", "mass" +value-titles=Filesystem, MASS +compulsory=true +sort-key=a1 + +[template variables=m06_data_path] +ns=Models and Cases/Model 06 +title=Data path +description=The path to the forecast. +help=Full path (including file name) to the forecast data on your chosen storage + system. Can contain wildcards. No quotation marks required in rose edit, as + it is already quoted there. + + strftime format strings are supported, and will be replaced with the + desired case study date or trial time. E.g: `/data/%Y%m%d/model1/*.nc` + + For more on strftime format strings, see: https://strftime.org/ +type=quoted +compulsory=true +sort-key=a2 + +[template variables=m06_date_type] +ns=Models and Cases/Model 06 +title=Date placeholder type +description=Type of date templated into the data path. +help=The type of date templated into the data path. Affects interpretation of + strftime placeholders in the data path. + + Validity time is when the data is predicting for. + + Forecast initiation time, AKA data time, is the time of the validity time of + the first data point. For realtime forecasts this is approximately when the + forecast was started. + + Forecast lead time is how far from the forecast initiation time the data is. +values=validity, initiation, lead +value-titles=Validity Time, Forecast Initiation Time, Forecast Lead Time +compulsory=true +trigger=template variables=m06_lead_time_forecast_initiation_time: lead; +sort-key=b1 + +[template variables=m06_lead_time_forecast_initiation_time] +ns=Models and Cases/Model 06 +title=Forecast initiation time +description=The initiation time from which the lead time is calculated. +help=The initiation time from which the lead time is calculated as an ISO 8601 + datetime. E.g: 2000-01-01T00:00Z +type=quoted +compulsory=true +sort-key=b2 + +[template variables=m06_preprocessing] +ns=Models and Cases/Model 06 +title=Preprocess +description=Preprocess all of the model data. +help=Whether to preprocess all of the model data. This is useful for applying + any necessary transformations to the data before it is used in the workflow, + such as removing boundary regions. +type=python_boolean +compulsory=true +trigger=template variables=m06_preprocessing_recipe: True; +sort-key=c1 + +[template variables=m06_preprocessing_recipe] +ns=Models and Cases/Model 06 +title=Preprocessing recipe +description=The preprocessing recipe to use. NOTE: Not yet implemented. +help=The preprocessing recipe to use. +type=quoted +compulsory=true +sort-key=c2 + + + +# Model 07 +[template variables=m07_data_source] +ns=Models and Cases/Model 07 +title=Data source +description=From whence to retrieve the forecast. +help=System from which to retrieve the forecast data. Filesystem is generic, + while the others are site-specific. +values="filesystem", "mass" +value-titles=Filesystem, MASS +compulsory=true +sort-key=a1 + +[template variables=m07_data_path] +ns=Models and Cases/Model 07 +title=Data path +description=The path to the forecast. +help=Full path (including file name) to the forecast data on your chosen storage + system. Can contain wildcards. No quotation marks required in rose edit, as + it is already quoted there. + + strftime format strings are supported, and will be replaced with the + desired case study date or trial time. E.g: `/data/%Y%m%d/model1/*.nc` + + For more on strftime format strings, see: https://strftime.org/ +type=quoted +compulsory=true +sort-key=a2 + +[template variables=m07_date_type] +ns=Models and Cases/Model 07 +title=Date placeholder type +description=Type of date templated into the data path. +help=The type of date templated into the data path. Affects interpretation of + strftime placeholders in the data path. + + Validity time is when the data is predicting for. + + Forecast initiation time, AKA data time, is the time of the validity time of + the first data point. For realtime forecasts this is approximately when the + forecast was started. + + Forecast lead time is how far from the forecast initiation time the data is. +values=validity, initiation, lead +value-titles=Validity Time, Forecast Initiation Time, Forecast Lead Time +compulsory=true +trigger=template variables=m07_lead_time_forecast_initiation_time: lead; +sort-key=b1 + +[template variables=m07_lead_time_forecast_initiation_time] +ns=Models and Cases/Model 07 +title=Forecast initiation time +description=The initiation time from which the lead time is calculated. +help=The initiation time from which the lead time is calculated as an ISO 8601 + datetime. E.g: 2000-01-01T00:00Z +type=quoted +compulsory=true +sort-key=b2 + +[template variables=m07_preprocessing] +ns=Models and Cases/Model 07 +title=Preprocess +description=Preprocess all of the model data. +help=Whether to preprocess all of the model data. This is useful for applying + any necessary transformations to the data before it is used in the workflow, + such as removing boundary regions. +type=python_boolean +compulsory=true +trigger=template variables=m07_preprocessing_recipe: True; +sort-key=c1 + +[template variables=m07_preprocessing_recipe] +ns=Models and Cases/Model 07 +title=Preprocessing recipe +description=The preprocessing recipe to use. NOTE: Not yet implemented. +help=The preprocessing recipe to use. +type=quoted +compulsory=true +sort-key=c2 + + + +# Model 08 +[template variables=m08_data_source] +ns=Models and Cases/Model 08 +title=Data source +description=From whence to retrieve the forecast. +help=System from which to retrieve the forecast data. Filesystem is generic, + while the others are site-specific. +values="filesystem", "mass" +value-titles=Filesystem, MASS +compulsory=true +sort-key=a1 + +[template variables=m08_data_path] +ns=Models and Cases/Model 08 +title=Data path +description=The path to the forecast. +help=Full path (including file name) to the forecast data on your chosen storage + system. Can contain wildcards. No quotation marks required in rose edit, as + it is already quoted there. + + strftime format strings are supported, and will be replaced with the + desired case study date or trial time. E.g: `/data/%Y%m%d/model1/*.nc` + + For more on strftime format strings, see: https://strftime.org/ +type=quoted +compulsory=true +sort-key=a2 + +[template variables=m08_date_type] +ns=Models and Cases/Model 08 +title=Date placeholder type +description=Type of date templated into the data path. +help=The type of date templated into the data path. Affects interpretation of + strftime placeholders in the data path. + + Validity time is when the data is predicting for. + + Forecast initiation time, AKA data time, is the time of the validity time of + the first data point. For realtime forecasts this is approximately when the + forecast was started. + + Forecast lead time is how far from the forecast initiation time the data is. +values=validity, initiation, lead +value-titles=Validity Time, Forecast Initiation Time, Forecast Lead Time +compulsory=true +trigger=template variables=m08_lead_time_forecast_initiation_time: lead; +sort-key=b1 + +[template variables=m08_lead_time_forecast_initiation_time] +ns=Models and Cases/Model 08 +title=Forecast initiation time +description=The initiation time from which the lead time is calculated. +help=The initiation time from which the lead time is calculated as an ISO 8601 + datetime. E.g: 2000-01-01T00:00Z +type=quoted +compulsory=true +sort-key=b2 + +[template variables=m08_preprocessing] +ns=Models and Cases/Model 08 +title=Preprocess +description=Preprocess all of the model data. +help=Whether to preprocess all of the model data. This is useful for applying + any necessary transformations to the data before it is used in the workflow, + such as removing boundary regions. +type=python_boolean +compulsory=true +trigger=template variables=m08_preprocessing_recipe: True; +sort-key=c1 + +[template variables=m08_preprocessing_recipe] +ns=Models and Cases/Model 08 +title=Preprocessing recipe +description=The preprocessing recipe to use. NOTE: Not yet implemented. +help=The preprocessing recipe to use. +type=quoted +compulsory=true +sort-key=c2 + + + +# Model 09 +[template variables=m09_data_source] +ns=Models and Cases/Model 09 +title=Data source +description=From whence to retrieve the forecast. +help=System from which to retrieve the forecast data. Filesystem is generic, + while the others are site-specific. +values="filesystem", "mass" +value-titles=Filesystem, MASS +compulsory=true +sort-key=a1 + +[template variables=m09_data_path] +ns=Models and Cases/Model 09 +title=Data path +description=The path to the forecast. +help=Full path (including file name) to the forecast data on your chosen storage + system. Can contain wildcards. No quotation marks required in rose edit, as + it is already quoted there. + + strftime format strings are supported, and will be replaced with the + desired case study date or trial time. E.g: `/data/%Y%m%d/model1/*.nc` + + For more on strftime format strings, see: https://strftime.org/ +type=quoted +compulsory=true +sort-key=a2 + +[template variables=m09_date_type] +ns=Models and Cases/Model 09 +title=Date placeholder type +description=Type of date templated into the data path. +help=The type of date templated into the data path. Affects interpretation of + strftime placeholders in the data path. + + Validity time is when the data is predicting for. + + Forecast initiation time, AKA data time, is the time of the validity time of + the first data point. For realtime forecasts this is approximately when the + forecast was started. + + Forecast lead time is how far from the forecast initiation time the data is. +values=validity, initiation, lead +value-titles=Validity Time, Forecast Initiation Time, Forecast Lead Time +compulsory=true +trigger=template variables=m09_lead_time_forecast_initiation_time: lead; +sort-key=b1 + +[template variables=m09_lead_time_forecast_initiation_time] +ns=Models and Cases/Model 09 +title=Forecast initiation time +description=The initiation time from which the lead time is calculated. +help=The initiation time from which the lead time is calculated as an ISO 8601 + datetime. E.g: 2000-01-01T00:00Z +type=quoted +compulsory=true +sort-key=b2 + +[template variables=m09_preprocessing] +ns=Models and Cases/Model 09 +title=Preprocess +description=Preprocess all of the model data. +help=Whether to preprocess all of the model data. This is useful for applying + any necessary transformations to the data before it is used in the workflow, + such as removing boundary regions. +type=python_boolean +compulsory=true +trigger=template variables=m09_preprocessing_recipe: True; +sort-key=c1 + +[template variables=m09_preprocessing_recipe] +ns=Models and Cases/Model 09 +title=Preprocessing recipe +description=The preprocessing recipe to use. NOTE: Not yet implemented. +help=The preprocessing recipe to use. +type=quoted +compulsory=true +sort-key=c2 + + + +# Model 10 +[template variables=m10_data_source] +ns=Models and Cases/Model 10 +title=Data source +description=From whence to retrieve the forecast. +help=System from which to retrieve the forecast data. Filesystem is generic, + while the others are site-specific. +values="filesystem", "mass" +value-titles=Filesystem, MASS +compulsory=true +sort-key=a1 + +[template variables=m10_data_path] +ns=Models and Cases/Model 10 +title=Data path +description=The path to the forecast. +help=Full path (including file name) to the forecast data on your chosen storage + system. Can contain wildcards. No quotation marks required in rose edit, as + it is already quoted there. + + strftime format strings are supported, and will be replaced with the + desired case study date or trial time. E.g: `/data/%Y%m%d/model1/*.nc` + + For more on strftime format strings, see: https://strftime.org/ +type=quoted +compulsory=true +sort-key=a2 + +[template variables=m10_date_type] +ns=Models and Cases/Model 10 +title=Date placeholder type +description=Type of date templated into the data path. +help=The type of date templated into the data path. Affects interpretation of + strftime placeholders in the data path. + + Validity time is when the data is predicting for. + + Forecast initiation time, AKA data time, is the time of the validity time of + the first data point. For realtime forecasts this is approximately when the + forecast was started. + + Forecast lead time is how far from the forecast initiation time the data is. +values=validity, initiation, lead +value-titles=Validity Time, Forecast Initiation Time, Forecast Lead Time +compulsory=true +trigger=template variables=m10_lead_time_forecast_initiation_time: lead; +sort-key=b1 + +[template variables=m10_lead_time_forecast_initiation_time] +ns=Models and Cases/Model 10 +title=Forecast initiation time +description=The initiation time from which the lead time is calculated. +help=The initiation time from which the lead time is calculated as an ISO 8601 + datetime. E.g: 2000-01-01T00:00Z +type=quoted +compulsory=true +sort-key=b2 + +[template variables=m10_preprocessing] +ns=Models and Cases/Model 10 +title=Preprocess +description=Preprocess all of the model data. +help=Whether to preprocess all of the model data. This is useful for applying + any necessary transformations to the data before it is used in the workflow, + such as removing boundary regions. +type=python_boolean +compulsory=true +trigger=template variables=m10_preprocessing_recipe: True; +sort-key=c1 + +[template variables=m10_preprocessing_recipe] +ns=Models and Cases/Model 10 +title=Preprocessing recipe +description=The preprocessing recipe to use. NOTE: Not yet implemented. +help=The preprocessing recipe to use. +type=quoted +compulsory=true +sort-key=c2 + ################################################################################ # Diagnostics @@ -497,7 +1413,9 @@ sort-key=model1 [template variables=LFRIC_DOMAIN_MEAN_VERTICAL_PROFILE_SERIES] ns=Diagnostics description=Domain averaged vertical profile for each validity time. -help=See includes/lfric_deterministic_domain_mean_vertical_profile_series.cylc. Currently vertical profiles for LFRic only work with LFRIC_MODEL_LEVELS as we currently don't have LFRIC data with a pressure or height coordinate. +help=See includes/lfric_deterministic_domain_mean_vertical_profile_series.cylc. + Currently vertical profiles for LFRic only work with LFRIC_MODEL_LEVELS as + we currently don’t have LFRIC data with a pressure or height coordinate. type=python_boolean trigger=template variables=LFRIC_PRESSURE_LEVEL_MODEL_FIELDS: True; template variables=LFRIC_PRESSURE_LEVELS: True; @@ -658,7 +1576,7 @@ sort-key=subsection1 [template variables=SUBAREA_LAT_BOUND_TOP] ns=Diagnostics description=Top edge coordinate of the sub-area, real. -help=Recommend looking at the input data to get these values. Uses the grid's native units. +help=Recommend looking at the input data to get these values. Uses the grid’s native units. type=real sort-key=subsection2 compulsory=true @@ -666,7 +1584,7 @@ compulsory=true [template variables=SUBAREA_LAT_BOUND_BOTTOM] ns=Diagnostics description=Bottom edge coordinate of the sub-area, real. -help=Recommend looking at the input data to get these values. Uses the grid's native units. +help=Recommend looking at the input data to get these values. Uses the grid’s native units. type=real sort-key=subsection2 compulsory=true @@ -674,7 +1592,7 @@ compulsory=true [template variables=SUBAREA_LON_BOUND_LEFT] ns=Diagnostics description=Left edge coordinate of the sub-area, real. -help=Recommend looking at the input data to get these values. Uses the grid's native units. +help=Recommend looking at the input data to get these values. Uses the grid’s native units. type=real sort-key=subsection2 compulsory=true @@ -682,7 +1600,7 @@ compulsory=true [template variables=SUBAREA_LON_BOUND_RIGHT] ns=Diagnostics description=Right edge coordinate of the sub-area, real. -help=Recommend looking at the input data to get these values. Uses the grid's native units. +help=Recommend looking at the input data to get these values. Uses the grid’s native units. type=real sort-key=subsection2 compulsory=true