ACCESS-NRI ENSO diagnostics CLIVAR porting

.zenodo.json

@@ -410,6 +410,11 @@
       "affiliation": "Met Office, UK",
       "name": "Munday, Gregory",
       "orcid": "0000-0003-4750-9923"
+    },
+    {
+      "affiliation": "ACCESS-NRI, Australia",
+      "name": "Chun, Felicity",
+      "orcid": "0009-0007-0845-0953"
     }
   ],
   "description": "ESMValTool: A community diagnostic and performance metrics tool for routine evaluation of Earth system models in CMIP.",

CITATION.cff

@@ -421,6 +421,11 @@ authors:
     family-names: Munday
     given-names: Gregory
     orcid: "https://orcid.org/0000-0003-4750-9923"
+  -
+    affiliation: "ACCESS-NRI, Australia"
+    family-names: Chun
+    given-names: Felicity
+    orcid: "https://orcid.org/0009-0007-0845-0953"
 
 cff-version: 1.2.0
 date-released: 2024-07-04

doc/sphinx/source/recipes/index.rst

@@ -130,6 +130,7 @@ Ocean
    recipe_cvdp
    recipe_combined_indices
    recipe_esacci_oc
+   recipe_enso_metrics
    recipe_oceans
    recipe_sea_surface_salinity
    recipe_russell18jgr

doc/sphinx/source/recipes/recipe_enso_metrics.rst

@@ -0,0 +1,72 @@
+.. _recipes_enso_metrics:
+
+ENSO CLIVAR metrics - reproducing ENSO characteristics lifecycle and seasonality
+================================================================================
+
+Overview
+--------
+
+Reproducing some ENSO metrics from the 
+[CLIVAR package](https://pcmdi.llnl.gov/pmp-preliminary-results/interactive_plot/portrait_plot/enso_metric/enso_metrics_interactive_portrait_plots_v20231121.html)
+specifically ones used for REF
+
+Available recipes and diagnostics
+---------------------------------
+
+Recipes are stored in esmvaltool/recipes/
+
+* recipe_enso_metrics.yml
+
+Diagnostics are stored in esmvaltool/diag_scripts/enso_metrics/
+
+* **enso_diag1metrics.py**: metrics for basic ENSO characteristics
+* **matrix.py**: reads metrics in work_dir from csv file written out in climatology_diagnostic1, use for other groups of metrics
+
+
+User settings in recipe
+-----------------------
+
+#. Script: **matrix.py**
+
+   *Required settings for script*
+
+   * **diag_metrics**: diagnostic name and script name in *yml* of the diagnostic that computes all the metrics 
+   so it can find the *csv* in the `work_dir` - eg. diagnostic_metrics/plot_script
+
+
+Variables
+---------
+
+* tos (Omon, monthly)
+* areacello (Ofx)
+
+
+
+Observations and reformat scripts
+---------------------------------
+
+
+* HadISST
+* TropFLUX
+
+
+References
+----------
+
+* [1] https://pcmdi.llnl.gov/pmp-preliminary-results/interactive_plot/portrait_plot/enso_metric/enso_metrics_interactive_portrait_plots_v20231121.html
+* [2] https://github.com/CLIVAR-PRP/ENSO_metrics/
+
+Example plots
+-------------
+
+.. _fig_seasonality:
+.. figure::  /recipes/figures/enso_metrics/seasonality.png
+   :align:   center
+
+   Add figure caption here.
+
+.. _fig_lifecycle:
+.. figure::  /recipes/figures/enso_metrics/lifecycle.png
+   :align:   center
+
+   Add figure caption here.

esmvaltool/config-references.yml

@@ -163,6 +163,11 @@ authors:
     name: Chen, Jack
     institute: NCAR, USA
     orcid:
+  chun_felicity:
+    name: Chun, Felicity
+    institute: ACCESS-NRI, Australia
+    orcid: https://orcid.org/0009-0007-0845-0953
+    github: flicj191
   cionni_irene:
     name: Cionni, Irene
     institute: ENEA, Italy