stc_qbo_enso #492

delsbury · 2023-11-01T17:00:03Z

This driver script (stc_qbo_enso.py) and its associated helper script (stc_qbo_enso_plottingcodeqbo.py and stc_qbo_enso_plottingcodeenso.py) do calculations to assess the representation of stratospheric teleconnections associated with the Quasi-Biennial Oscillation (QBO) and the El Nino Southern Oscillation (ENSO).

Associated issue # (replace this phrase and parentheses with the issue number)

How Has This Been Tested?
The POD has been tested with 1979-2014 data from "CESM2-WACCM_CMIP_historical_r1i1p1f1," the historical simulation for the first CESM2-WACCM ensemble member. The "run script" is called "config_file.jsonc." Running the POD produces six plots (3 for each hemisphere, north vs. south) that show the atmospheric response to the Quasi-Biennial Oscillation (QBO) and six plots (3 for each hemisphere) that show the atmospheric response to the El Nino Southern Oscillation. Observational equivalents are also produced using ERA5 data. The POD saves the model output file in the model/netCDF folder. The run time for the entire POD is ~ 25 minutes. Much of the POD code was written using Python 3.8.18, but has been tested and runs successfully with the active MDTF Python environments that use Python 3.11 >. The POD uses the following Python packages, with their versions shown in parentheses: xarray (20231.1.0), numpy (1.24.3), xesmf (0.6.0), matplotlib (3.2.2), cartopy (0.18.0), and scipy (1.9.1). Note that the POD runs successfuly with the MDTF conda environments activated, which means its robust to different versions of the aforementioned packages. All of this work was done of Mac OSX (current version: 12.7.1)

Checklist:

My branch is up-to-date with the NOAA-GFDL main branch, and all merge conflicts are resolved

YES

The scripts are written in Python 3.11 or above (preferred; required if funded by a CPO grant), NCL, or R

YES

All of my scripts are in the diagnostics/[POD short name] subdirectory, and include a main_driver script, template html, and settings.jsonc file

YES

I have made corresponding changes to the documentation in the POD's doc/ subdirectory
I have requested that the framework developers add packages required by my POD to the python3, NCL, or R environment yaml file if necessary, and my environment builds with conda_env_setup.sh
I have added any necessary data to input_data/obs_data/[pod short name] and/or input_data/model/[pod short name]

YES

My code is portable; it uses MDTF environment variables, and does not contain hard-coded file or directory paths

YES

I have provided the code to generate digested data files from raw data files

YES

Each digested data file generated by the script contains numerical data (no figures), and is 3 GB or less in size

YES

I have included copies of the figures generated by the POD in the pull request

YES

The repository contains no extra test scripts or data files

YES

CESM2-WACCM_CMIP_historical_r1i1p1f1-1979-2014-qbo30hPa-metrics.txt

…accept daily and monthly input

github-advanced-security

CodeQL found more than 10 potential problems in the proposed changes. Check the Files changed tab for more details.

wrongkindofdoctor

@delsbury Thanks for submitting your POD to the MDTF-diagnostics repo. The documentation and POD scripts are in good shape-there is just some minor cleanup needed before I can merge the stc_qbo_enso POD into the main branch. In addition to the unused variables and imports identified by CodeQL, please make the requested changes to your PR.

wrongkindofdoctor · 2023-11-09T20:28:59Z

config_file.jsonc

@@ -0,0 +1,125 @@
+// Configuration for MDTF-diagnostics driver script self-test.
+//
+// Copy this file and customize the settings as needed to run the framework on


Please move this file to diagnostics/stc_qbo_enso

wrongkindofdoctor · 2023-11-09T20:40:20Z

mdtf_framework.py

@@ -54,6 +54,7 @@ def main(argv):
        return 0 # will actually exit from print_help
    else:
        # case where we run the actual framework
+        print ('HERE')


Remove debug print statement from framework code

wrongkindofdoctor · 2023-11-09T20:40:49Z

src/cli.py

@@ -1049,6 +1049,8 @@ class MDTFTopLevelArgParser(MDTFArgParser):
    """Class for constructing the command-line interface, parsing the options,
    and handing off execution to the selected subcommand.
    """
+


Remove debugging print statement from framework code

wrongkindofdoctor · 2023-11-09T20:41:14Z

src/data_model.py

@@ -616,7 +616,10 @@ def build_axes(self, *coords, verify=True):
            # validate that we don't have duplicate axes
            d = util.WormDict()
            verify_d = util.WormDict()
+            print (verify_d, "verify_d")


Remove debugging print statements from framework code

wrongkindofdoctor · 2023-11-09T20:41:32Z

src/diagnostic.py

@@ -483,6 +483,7 @@ def _iter_shallow_alternates(var):
            for alts in v.alternates:
                linked_alts.append([vlist_vars[v_name] for v_name in alts])
            v.alternates = linked_alts
+        print (list(vlist_vars.values()), "list(vlist_vars.values())")


Remove debugging print statement from framework code

wrongkindofdoctor · 2023-11-09T20:41:54Z

src/diagnostic.py

@@ -873,6 +874,7 @@ def from_struct(cls, pod_name, d, parent, **kwargs):
                                      pod_name) from exc
        try:
            pod.varlist = Varlist.from_struct(d, parent=pod)
+            print (pod.varlist, "pod.varlist")


Remove debugging print statement from framework code

wrongkindofdoctor · 2023-11-09T20:43:42Z

diagnostics/stc_qbo_enso/stc_qbo_enso.html

+The names of any environment variables set for the diagnostic (enclosed in 
+curly braces) will be replaced by the same values they had when the diagnostic 
+was run. For example, this diagnostic's favorite color is "{{EXAMPLE_FAV_COLOR}}."
+</p>


Remove template lines

wrongkindofdoctor · 2023-11-09T20:44:11Z

diagnostics/stc_qbo_enso/stc_qbo_enso.html

+<title>MDTF example diagnostic</title>
+<img src="../mdtf_diag_banner.png">
+<h3>Example diagnostic: time-averaged near-surface temperature</h3>
+<p>


Change title and short description to match your POD

delsbury added 8 commits November 1, 2023 09:07

updated this script, which I debugged in pursuit of modifying POD to …

d1ed567

…accept daily and monthly input

updated this to accept sea surface temperature inputs

90e9d9d

some updates

073cada

all files

410841e

adding rst file

353ae31

updated changes 2

94d8927

updated config

b85e557

same files

5c217a0

delsbury requested review from jkrasting, wrongkindofdoctor and aradhakrishnanGFDL as code owners November 1, 2023 17:00

wrongkindofdoctor self-assigned this Nov 1, 2023

wrongkindofdoctor added the diagnostic Issue pertains to a contributed diagnostic label Nov 1, 2023

github-advanced-security bot found potential problems Nov 1, 2023

View reviewed changes

wrongkindofdoctor requested changes Nov 9, 2023

View reviewed changes

delsbury closed this by deleting the head repository Nov 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

stc_qbo_enso #492

stc_qbo_enso #492

delsbury commented Nov 1, 2023

github-advanced-security bot left a comment

wrongkindofdoctor left a comment

wrongkindofdoctor Nov 9, 2023

wrongkindofdoctor Nov 9, 2023

wrongkindofdoctor Nov 9, 2023

wrongkindofdoctor Nov 9, 2023

wrongkindofdoctor Nov 9, 2023

wrongkindofdoctor Nov 9, 2023

wrongkindofdoctor Nov 9, 2023

wrongkindofdoctor Nov 9, 2023

stc_qbo_enso #492

stc_qbo_enso #492

Conversation

delsbury commented Nov 1, 2023

github-advanced-security bot left a comment

Choose a reason for hiding this comment

wrongkindofdoctor left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment