Feature 1399 usecase cable

.github/parm/use_case_groups.json

@@ -61,13 +61,13 @@
   },
   {
     "category": "marine_and_cryosphere",
-    "index_list": "3-4",
+    "index_list": "3-5",
     "run": false
   },
   {
     "category": "marine_and_cryosphere",
-    "index_list": "5",
-    "run": false
+    "index_list": "6",
+    "run": true
   },
   {
     "category": "medium_range",

docs/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.py

@@ -0,0 +1,160 @@
+"""
+UserScript: Python Embedding to compute cable transport
+=======================================================
+
+model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf
+
+"""
+##############################################################################
+# Scientific Objective
+# --------------------
+# The Florida Current flows northward along the eastern Florida coast and feeds to the Gulf Stream. More info can
+# be obtained from: https://www.aoml.noaa.gov/phod/floridacurrent/index.php
+#
+# This use case utilizes Python embedding to calculate transport (units Sv) variations of the Florida current
+# using a submarine cable and snapshot estimates made by shipboard instruments. The code compares the transport 
+# using RTOFS data and compare it with the AOML cable transport data and computes BIAS, RMSE, CORRELATION, and 
+# Scatter Index. The operational code utilizes 21 days of data and computes 7 day statistics. 
+# For the use case 3 days of data are utilized. The valid date is passed though an argument. The valid date 
+# is the last processed day i.e. the code grabs 3 previous days of data.    
+
+##############################################################################
+# Datasets
+# ---------------------
+#
+# | **Forecast:** RTOFS u(3zuio) amd ,v(3zvio) files via Python Embedding script/file
+#
+# | **Observations:** AOML Florida Current data via Python Embedding script/file
+#
+#
+# | **Location:** All of the input data required for this use case can be found in the met_test sample data tarball. Click here to the METplus releases page and download sample data for the appropriate release: https://github.com/dtcenter/METplus/releases
+# | This tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See `Running METplus`_ section for more information.
+#
+# | **Data Source:** NOMADS RTOFS Global + Daily mean transport (https://www.aoml.noaa.gov/phod/floridacurrent/data_access.php)+ Eightmilecable (static, provided with the use case)
+
+##############################################################################
+# External Dependencies
+# ---------------------
+#
+# You will need to use a version of Python 3.6+ that has the following packages installed:
+#
+# * scikit-learn
+# * pyproj
+#
+# If the version of Python used to compile MET did not have these libraries at the time of compilation, you will need to add these packages or create a new Python environment with these packages.
+#
+# If this is the case, you will need to set the MET_PYTHON_EXE environment variable to the path of the version of Python you want to use. If you want this version of Python to only apply to this use case, set it in the [user_env_vars] section of a METplus configuration file.:
+#
+#    [user_env_vars]
+#    MET_PYTHON_EXE = /path/to/python/with/required/packages/bin/python
+
+##############################################################################
+# METplus Components
+# ------------------
+#
+# This use case utilizes the METplus UserScript wrapper to generate a
+# command to run with Python Embedding for the specified valid time. 
+
+##############################################################################
+# METplus Workflow
+# ----------------
+#
+# This use case uses UserScript. All the gridded data being pulled from the files via Python Embedding. 
+# All of the desired statistics are in the log file.
+# It processes the following run time:
+#
+# | **Valid:** 2021-10-28
+# 
+# The code grabs the 20211028, 20211027, and 20211026 24 hour RTOFS files. 
+
+##############################################################################
+# METplus Configuration
+# ---------------------
+#
+# METplus first loads all of the configuration files found in parm/metplus_config,
+# then it loads any configuration files passed to METplus via the command line
+# with the -c option, i.e. -c parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf
+#
+# .. highlight:: bash
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf
+
+##############################################################################
+# MET Configuration
+# ---------------------
+#
+# None. All of the processing is completed in the UserScript
+#
+
+##############################################################################
+# Python Embedding
+# ----------------
+#
+# This use case uses one Python script to read forecast and observation data
+# as well as processing the desired statistics.
+#
+# parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport/read_aomlcable_rtofs_transport.py
+#
+# .. highlight:: python
+# .. literalinclude:: ../../../../parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport/read_aomlcable_rtofs_transport.py
+#
+
+##############################################################################
+# Running METplus
+# ---------------
+#
+# This use case can be run two ways:
+#
+# 1) Passing in UserScript_fcstRTOFS_obsAOML_calcTransport.conf then a user-specific system configuration file::
+#
+#        run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf -c /path/to/user_system.conf
+#
+# 2) Modifying the configurations in parm/metplus_config, then passing in UserScript_fcstRTOFS_obsAOML_calcTransport.conf::
+#
+#        run_metplus.py -c /path/to/METplus/parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf
+#
+# The former method is recommended. Whether you add them to a user-specific configuration file or modify the metplus_config files, the following variables must be set correctly:
+#
+# * **INPUT_BASE** - Path to directory where sample data tarballs are unpacked (See Datasets section to obtain tarballs). This is not required to run METplus, but it is required to run the examples in parm/use_cases
+# * **OUTPUT_BASE** - Path where METplus output will be written. This must be in a location where you have write permissions
+# * **MET_INSTALL_DIR** - Path to location where MET is installed locally
+#
+# Example User Configuration File::
+#
+#   [dir]
+#   INPUT_BASE = /path/to/sample/input/data
+#   OUTPUT_BASE = /path/to/output/dir
+#   MET_INSTALL_DIR = /path/to/met-X.Y 
+#
+# **NOTE:** All of these items must be found under the [dir] section.
+#
+
+##############################################################################
+# Expected Output
+# ---------------
+#
+# A successful run will output the following both to the screen and to the logfile::
+#
+#   INFO: METplus has successfully finished running.
+#
+# Refer to the value set for **OUTPUT_BASE** to find where the output data was generated.
+# Output for use case will be found in calc_transport (relative to **OUTPUT_BASE**)
+# and will contain the following files:
+#
+# * calc_transport.log 
+
+##############################################################################
+# Keywords
+# --------
+#
+# .. note::
+#
+#   * UserScriptUseCase
+#   * PythonEmbeddingFileUseCase
+#   * MarineAndCryosphereAppUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
+# sphinx_gallery_thumbnail_path = '_static/marine_and_cryosphere-UserScript_fcstRTOFS_obsAOML_calcTransport.png'
+

internal_tests/use_cases/all_use_cases.txt

@@ -93,6 +93,7 @@ Category: marine_and_cryosphere
 3::GridStat_fcstRTOFS_obsSMOS_climWOA_sss::model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMOS_climWOA_sss.conf:: icecover_env, py_embed
 4::GridStat_fcstRTOFS_obsSMAP_climWOA_sss::model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsSMAP_climWOA_sss.conf:: icecover_env, py_embed
 5::GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh::model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsAVISO_climHYCOM_ssh.conf:: icecover_env, py_embed
+6::UserScript_fcstRTOFS_obsAOML_calcTransport::model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf:: icecover_env, py_embed
 #X::GridStat_fcstRTOFS_obsGHRSST_climWOA_sst::model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst.conf, model_applications/marine_and_cryosphere/GridStat_fcstRTOFS_obsGHRSST_climWOA_sst/ci_overrides.conf:: icecover_env, py_embed
 
 

metplus/VERSION

@@ -1 +1 @@
-5.0.0-beta1-dev
+5.0.0-beta1-dev

parm/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport.conf

@@ -0,0 +1,73 @@
+[config]
+
+# List of applications to run
+PROCESS_LIST = UserScript
+
+# time looping - options are INIT, VALID, RETRO, and REALTIME
+# If set to INIT or RETRO:
+#   INIT_TIME_FMT, INIT_BEG, INIT_END, and INIT_INCREMENT must also be set
+# If set to VALID or REALTIME:
+#   VALID_TIME_FMT, VALID_BEG, VALID_END, and VALID_INCREMENT must also be set
+LOOP_BY = VALID
+
+# Format of INIT_BEG and INIT_END using % items
+# %Y = 4 digit year, %m = 2 digit month, %d = 2 digit day, etc.
+# see www.strftime.org for more information
+# %Y%m%d%H expands to YYYYMMDDHH
+VALID_TIME_FMT = %Y%m%d
+
+# Start time for METplus run - must match VALID_TIME_FMT
+VALID_BEG = 20211028
+
+# Increment between METplus runs (in seconds if no units are specified)
+#  Must be >= 60 seconds
+VALID_INCREMENT = 24H
+
+# List of forecast leads to process for each run time (init or valid)
+# In hours if units are not specified
+# If unset, defaults to 0 (don't loop through forecast leads)
+LEAD_SEQ = 
+
+# Order of loops to process data - Options are times, processes
+# Not relevant if only one item is in the PROCESS_LIST
+# times = run all wrappers in the PROCESS_LIST for a single run time, then
+#   increment the run time and run all wrappers again until all times have
+#   been evaluated.
+# processes = run the first wrapper in the PROCESS_LIST for all times
+#   specified, then repeat for the next item in the PROCESS_LIST until all
+#   wrappers have been run
+
+LOOP_ORDER = processes
+
+USER_SCRIPT_RUNTIME_FREQ = RUN_ONCE
+
+USER_SCRIPT_OUTPUT_DIR = {OUTPUT_BASE}/model_applications/marine_and_cryosphere/calc_transport
+
+USER_SCRIPT_INPUT_TEMPLATE = {VALID_BEG}
+
+# The valid date increments backwards 
+USER_SCRIPT_COMMAND = {PARM_BASE}/use_cases/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport/read_aomlcable_rtofs_transport.py {USER_SCRIPT_INPUT_TEMPLATE}
+
+
+[user_env_vars]
+
+# Calc Transport specific variables
+
+CALC_TRANSPORT_RTOFS_DIRNAME = {INPUT_BASE}/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport/RTOFS
+
+CALC_TRANSPORT_CABLE_FILENAME = {INPUT_BASE}/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport/FC_cable_transport_2021.dat
+
+CALC_TRANSPORT_EIGHTMILE_FILENAME = {INPUT_BASE}/model_applications/marine_and_cryosphere/UserScript_fcstRTOFS_obsAOML_calcTransport/eightmilecable.dat
+
+CALC_TRANSPORT_LEAD_TIME = 24 
+
+# Calculate stats for number of days. The operational website uses 21 days 
+# of data and then calculates 7 day stats. For the use case both of them are 3 days each. 
+# The code calculates the number of subdirectories 
+# under RTOFS directory, however, CALC_TRANSPORT_STATS_DAY is the number of days the statistics 
+# will be calculated. 
+CALC_TRANSPORT_STATS_DAY = 3
+
+CALC_TRANSPORT_LOG_FILE = calc_transport.log
+
+OUTPUT_DIR = {OUTPUT_BASE}/model_applications/marine_and_cryosphere/calc_transport