Skip to content

Commit

Permalink
Updating workflow descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
CPKalb committed Nov 7, 2024
1 parent 1fd9852 commit f3599e0
Show file tree
Hide file tree
Showing 5 changed files with 253 additions and 146 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -57,21 +57,9 @@
# METplus Components
# ------------------
#
# This use case calls UserScript twice. The first UserScript creates a list of the EOF files
# needed for the calculation. It is done separately since the EOF files are needed for each day
# of the year while the OMI calculation is on a separate time frame. The second UserScript runs the
# OMI calculation.
#
# There are three optional pre-processing steps for the OMI calculation. These include using PcpCombine to
# compute daily averages for the forecast, and using RegridDataPlane for both the model and observations
# to cut the grid to only include -20 to 20 latitude. These omitted steps can be turned back on by using the
# PROCESS_LIST that is commented out:
#
# PROCESS_LIST = PcpCombine(daily_mean_fcst), RegridDataPlane(regrid_obs_olr), RegridDataPlane(regrid_fcst_olr), UserScript(create_eof_filelist), UserScript(script_omi)
#
# Settings for the optional pre-processing steps can be found in the respective sections of the configuration,
# daily_mean_fcst, regrid_obs_olr, and regrid_fcst_olr. Data is not provided in the tarball to run these steps,
# but the configurations are provided for reference on how to set up these calculations.
# This use case calls UserScript twice, first to create a list of EOF files and then to run
# the OMI calculation. In addition, there are three optional pre-processing steps, PCP-Combine
# and two calls to Regrid-Data-Plane.
#
# This use case requires METcalcpy, METplotpy, and METdataio to run. The metcalcpy scripts accessed include the following:
#
Expand All @@ -98,8 +86,21 @@
# **Sequence of forecast leads to process (LEAD_SEQ):** 0
#
# This use case does not loop, but the UserScript to create and EOF filelist is run once and the OMI driver script is
# run once for both the model and observations across the entire time period. The 3 optional pre-processing steps
# loop by valid time when they are turned on. The Phase diagram plots are created over a different time frame than the
# run once for both the model and observations across the entire time period. The EOF filelist is created separately
# since the EOF files are needed for each day of the year while the OMI calculation is on a separate time frame.

# The 3 optional pre-processing steps loop by valid time when they are turned on. The steps include using PcpCombine to
# compute daily averages for the forecast, and using RegridDataPlane for both the model and observations
# to cut the grid to only include -20 to 20 latitude. These omitted steps can be turned back on by using the
# PROCESS_LIST that is commented out:
#
# PROCESS_LIST = PcpCombine(daily_mean_fcst), RegridDataPlane(regrid_obs_olr), RegridDataPlane(regrid_fcst_olr), UserScript(create_eof_filelist), UserScript(script_omi)
#
# Settings for the optional pre-processing steps can be found in the respective sections of the configuration,
# daily_mean_fcst, regrid_obs_olr, and regrid_fcst_olr. Data is not provided in the tarball to run these steps,
# but the configurations are provided for reference on how to set up these calculations.
#
# The Phase diagram plots are created over a different time frame than the
# calculation, 01-01-2017 to 03-31-2017 for both plots.

##############################################################################
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,31 +56,20 @@
# METplus Components
# ------------------
#
# This use case calls UserScript twice. The first UserScript creates a list of the EOF files
# needed for the calculation. It is done separately since the EOF files are needed for each day
# of the year while the OMI calculation is on a separate time frame. The second UserScript runs the
# OMI calculation.
#
# There is one optional pre-processing steps for the OMI calculation, using RegridDataPlane which cuts
# the observation grid to only include -20 to 20 latitude. This omitted step can be turned back on by
# using the PROCESS_LIST that is commented out:
#
# PROCESS_LIST = RegridDataPlane(regrid_obs_olr), UserScript(create_eof_filelist), UserScript(script_omi)
#
# Settings for the optional pre-processing step can be found in the regrid_obs_olr section of the configuration.
# Data is not provided in the tarball to run this steps, but the configurations is provided for reference on
# how to set up this step.
# This use case calls UserScript twice, first to create a list of EOF files and then to run
# the OMI calculation. In addition, there are three optional pre-processing steps, PCP-Combine
# and two calls to Regrid-Data-Plane.
#
# This use case requires METcalcpy, METplotpy, and METdataio to run. The metcalcpy scripts accessed include the following:

#
# * metcalcpy/contributed/rmm_omi/compute_mjo_indices.py
#
# The METplotpy scripts accessed include the following:

# * metplotpy/contributed/mjo_rmm_omi/plot_mjo_indioces.py
#
# * metplotpy/contributed/mjo_rmm_omi/plot_mjo_indioces.py
#
# The METdataio scripts accessed include the following:

#
# * METreadnc/util/read_netcdf.py

##############################################################################
Expand All @@ -96,8 +85,18 @@
# **Sequence of forecast leads to process (LEAD_SEQ):** 0
#
# This use case does not loop, but the UserScript to create and EOF filelist is run once and the OMI driver script is
# run once. The optional pre-processing step loops by valid time. The Phase diagram plot is created over a different time
# frame than the calculation, 10-01-2012 to 03-30-2012.
# run once. The EOF filelist is done separately since the EOF files are needed for each day of the year while the OMI
# calculation is on a separate time frame.The optional pre-processing step loops by valid time. The optional
# pre-processing step uses Regrid-Data-Plane to cut the observation grid to only include -20 to 20 latitude. This
# omitted step can be turned back on by using the PROCESS_LIST that is commented out:
#
# PROCESS_LIST = RegridDataPlane(regrid_obs_olr), UserScript(create_eof_filelist), UserScript(script_omi)
#
# Settings for the optional pre-processing step can be found in the regrid_obs_olr section of the configuration.
# Data is not provided in the tarball to run this steps, but the configurations is provided for reference on
# how to set up this step.

# The Phase diagram plot is created over a different time frame than the calculation, 10-01-2012 to 03-30-2012.

##############################################################################
# METplus Configuration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,22 +59,20 @@
# ------------------
#
# This use case calls UserScript first, Series-Analysis, and then UserScript
# a second time. The first call to UserScript runs zonal_mean_driver.py. This script
# computes zonal and meridional mean data from the directional_means program in
# METplotpy. Then, Series-Analysis is run on the zonal mean output to compute
# continuous statistics. Finally, the second call to UserScript runs bias_plot_driver.py
# which creates bias plots for temperature and wind.
# a second time. METcalcpy, METplotpy, and METdataio are needed for this use case to run.
# The metcalcpy scripts accessed include the following:
#
# METcalcpy, METplotpy, and METdataio are needed for this use case to run. The metcalcpy
# scripts accessed include the following:
# * metcalcpy/pre_processing/directional_means.py
#
# The METplotpy scripts accessed include the following:
#
# * metplotpy/stratosphere_diagnostics/stratosphere_plots.py
#
# The METdataio scripts accessed include the following:
#
# * METreadnc/util/read_netcdf.py


##############################################################################
# METplus Workflow
# ----------------
Expand All @@ -88,7 +86,14 @@
# **Sequence of forecast leads to process (LEAD_SEQ):** 24
#
# This use case does not loop. The two calls to UserScript are run once. Series-
# Analysis is also run once.
# Analysis is also run once. The first call to UserScript runs zonal_mean_driver.py.
# This script computes zonal and meridional mean data from the directional_means program in
# METplotpy. Then, Series-Analysis is run on the zonal mean output to compute
# continuous statistics. Finally, the second call to UserScript runs bias_plot_driver.py
# which creates bias plots for temperature and wind.
#
# METcalcpy 3.0.0 or higher, METplotpy 3.0.0 or higher, and METdataio 2.1 or higher are needed
# for this use case.

##############################################################################
# METplus Configuration
Expand All @@ -115,7 +120,6 @@
#
# .. dropdown:: SeriesAnalysisConfig_wrapped
#
# .. highlight:: bash
# .. literalinclude:: ../../../../parm/met_config/SeriesAnalysisConfig_wrapped

##############################################################################
Expand Down Expand Up @@ -158,7 +162,7 @@
# ---------------
#
# Pass the use case configuration file to the run_metplus.py script along with any
# user-specific system configuration files if desired:
# user-specific system configuration files if desired::
#
# run_metplus.py /path/to/METplus/parm/use_cases/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereBias.conf /path/to/user_system.conf
#
Expand All @@ -172,10 +176,11 @@
#
# INFO: METplus has successfully finished running.
#
# Refer to the value set for **OUTPUT_BASE** to find where the output data was generated. Output for this use
# case will be found in model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratosphereBias (relative
# to **OUTPUT_BASE**). The output includes the zonal mean files for the forecast and observations, the
# output from Series-Analysis, and bias plots. There are two bias plots output::
# Refer to the value set for **OUTPUT_BASE** to find where the output data was generated.
# Output for this use case will be found in
# {OUTPUT_BASE}/model_applications/s2s_stratosphere/UserScript_fcstGFS_obsERA_StratospherePolar
# The output includes the netCDF zonal mean files for the forecast and observations, netCDF output
# from Series-Analysis, and bias plots. There are two bias plots output::
#
# * plots/GFS_ERA_ME_2018_02_zonal_mean_T.png
# * plots/GFS_ERA_ME_2018_02_zonal_mean_U.png
Expand All @@ -202,7 +207,7 @@
# * SeriesAnalysis/series_analysis_files_obs_init_ALL_valid_ALL_lead_ALL.txt
#
# The zonal mean output includes 28 files for the forecast
# and observations, one for each day. The file format for February 1 is:
# and observations, one for each day. The file format for February 1 is::
#
# * FCST/FCST_zonal_mean_U_T_20180201_000000.nc
# * OBS/OBS_zonal_mean_U_T_20180201_000000.nc
Expand Down
Loading

0 comments on commit f3599e0

Please sign in to comment.