Skip to content

Commit

Permalink
Minor code improvements; include new comments/improve comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
@gsketefian
gsketefian committed Dec 3, 2024
1 parent 5fc6a96 commit a22ddb4
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 29 deletions.
9 changes: 9 additions & 0 deletions ush/config_defaults.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2404,6 +2404,15 @@ verification:
#
VX_OUTPUT_BASEDIR: '{% if user.RUN_ENVIR == "nco" %}$COMOUT/metout{% else %}{{ workflow.EXPTDIR }}{% endif %}'
#
# VX_VERIFY_AGAINST_BENCHMARK_FCST:
# Flag that specifies whether the verification will use a benchmark
# forecast as the truth instead of obs.
#
# VX_BENCHMARK_FCST_MODEL_NAME:
# The name of the benchmark forecast against which the verification will
# be performed. Used only if VX_VERIFY_AGAINST_BENCHMARK_FCST is set to
# True.
#
VX_VERIFY_AGAINST_BENCHMARK_FCST: False
VX_BENCHMARK_FCST_MODEL_NAME: 'no_model'
#
Expand Down
85 changes: 56 additions & 29 deletions ush/setup.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -739,10 +739,17 @@ def _remove_tag(tasks, tag):
#
# -----------------------------------------------------------------------
#
# Remove all verification (meta)tasks for which no fields are specified.
# Remove all verification (meta)tasks for which no fields are specified
# or which do not make sense to include in the workflow, e.g. because the
# vx will be performed against a benchmark forecast, not obs (or vice-
# versa).
#
# -----------------------------------------------------------------------
#

# Construct a dictionary that, for each valid field group (the dictionary
# keys), contains a list of all possible top-level verification tasks and
# metatasks (the values) that may be included in the experiment's workflow.
vx_metatasks_all_possible_by_fg = {}

vx_metatasks_all_possible_by_fg["APCP"] \
Expand Down Expand Up @@ -785,50 +792,61 @@ def _remove_tag(tasks, tag):

vx_metatasks_all_possible_by_fg["UPA"] \
= vx_metatasks_all_possible_by_fg["SFC"]
#
# -----------------------------------------------------------------------
#
#
#
# -----------------------------------------------------------------------
#

# Create a set containing all possible top-level vx tasks and metatasks.
# This will be needed below in constructing the set of all (meta)tasks
# to exclude from the workflow. We generate this by simply collecting
# all the (meta)tasks in the lists in the dictionary constructed above
# and keeping only the unique ones.
vx_metatasks_all_possible \
= [metatask \
for fg, metatasks_for_fg in vx_metatasks_all_possible_by_fg.items() \
for metatask in metatasks_for_fg]
vx_metatasks_all_possible = set(vx_metatasks_all_possible)
#
# -----------------------------------------------------------------------
#
# Invert dictionary to get a new dictionary that, for each vx (meta)task
# (the keys), contains a list of its associated field groups (the values).
#
# -----------------------------------------------------------------------
#
vx_fieldgroups_by_metatask = {}

# Invert the dictionary constructed above that contains all possible top-
# level vx tasks and/or metatask for each valid field group to obtain a
# new dictionary that, for each possible/valid vx (meta)task (the keys),
# contains a list of the field groups for which it is needed (the values).
# This dictionary is needed below in generating an informational message
# when a (meta)task is being excluded from the workflow.
vx_fieldgroups_all_possible_by_metatask = {}
for metatask in sorted(list(vx_metatasks_all_possible)):
fg_list = []
for fg, metatasks in vx_metatasks_all_possible_by_fg.items():
if metatask in metatasks: fg_list.append(fg)
vx_fieldgroups_by_metatask[metatask] = fg_list
#
# -----------------------------------------------------------------------
#
#
#
# -----------------------------------------------------------------------
#
vx_fieldgroups_all_possible_by_metatask[metatask] = fg_list

# Construct a dictionary that is identical to the one above containing
# a list of all possible vx (meta)tasks for each valid field group (the
# keys) except that it does not contain key-value pairs for those field
# groups for which verification will not be performed, i.e. which are not
# included in the list VX_FIELD_GROUPS in the SRW App configuration file.
# This is needed below in constructing the list of all vx (meta)tasks to
# be included in the workflow.
vx_field_groups = vx_config["VX_FIELD_GROUPS"]
vx_metatasks_to_include_by_fg \
= {fg: metatasks for fg, metatasks in vx_metatasks_all_possible_by_fg.items() \
if fg in vx_field_groups}

# For the SFC and UPA field groups, whether we use grid-to-grid or grid-
# to-point verification depends on whether we are verifyfing against obs
# or another (benchmark) forecast.
# or another (benchmark) forecast, which is specified by the SRW config
# flag VX_VERIFY_AGAINST_BENCHMARK_FCST. If this is set to True, then
# the fields in the SFC and UPA field groups (in fact, all fields) will
# be given on a grid (that of the benchmark forecast), so grid-to-grid
# verification will be used for these field groups. On the other hand,
# if VX_VERIFY_AGAINST_BENCHMARK_FCST is set to False, then obs will be
# used to verify the SFC and UPA field groups. Since obs are not given
# on a grid, in this case only grid-to-point verification can be used for
# these field groups. Thus, depending on what VX_VERIFY_AGAINST_BENCHMARK_FCST
# is set to, we either drop the PointStat metatasks or the GridStat metatasks
# from the lists of (meta)tasks for the SFC and UPA field groups in the
# dictionary of (meta)tasks to include in the workflow. In addition, if
# verifying against a benchmark forecast, we drop any tasks involving the
# NDAS obs type since in that case, NDAS obs are not needed.
vx_config = expt_config["verification"]
vx_verify_against_benchmark_fcst = vx_config["VX_VERIFY_AGAINST_BENCHMARK_FCST"]
if vx_verify_against_benchmark_fcst:
if vx_config["VX_VERIFY_AGAINST_BENCHMARK_FCST"]:
vx_metatasks_to_exclude_from_SFC_UPA \
= ["task_get_obs_ndas",
"task_run_MET_Pb2nc_obs_NDAS",
Expand All @@ -845,14 +863,23 @@ def _remove_tag(tasks, tag):
= [metatask for metatask in vx_metatasks_to_include_by_fg[fg] \
if metatask not in vx_metatasks_to_exclude_from_SFC_UPA]

# Generate a set containing all the top-level vx (meta)tasks to include
# in the workflow from the lists in the dictionary of vx (meta)tasks to
# include constructed above. This will be used below to generate a set
# of vx (meta)tasks to exclude from the worklow.
vx_metatasks_to_include \
= [metatask \
for fg, metatasks_for_fg in vx_metatasks_to_include_by_fg.items() \
for metatask in metatasks_for_fg]
vx_metatasks_to_include = set(vx_metatasks_to_include)

# Construct set of all top-level vx (meta)tasks to exclude from the SRW
# workflow.
vx_metatasks_to_exclude = vx_metatasks_all_possible.difference(vx_metatasks_to_include)

# Drop from the rocoto configuration dictionary portion of the SRW config
# dictionary any top-level (meta)tasks that are in the set of (meta)tasks
# to exclude.
for metatask in vx_metatasks_to_exclude:
if metatask in rocoto_config['tasks']:
logging.info(dedent(
Expand All @@ -863,7 +890,7 @@ def _remove_tag(tasks, tag):
{vx_field_groups = }
does not include any of the field groups associated with this (meta)task,
which are
{vx_fieldgroups_by_metatask[metatask]}"""
{vx_fieldgroups_all_possible_by_metatask[metatask]}"""
))
rocoto_config['tasks'].pop(metatask)
#
Expand Down

0 comments on commit a22ddb4

Please sign in to comment.