Merge remote-tracking branch 'public/main' into causal_clouds

.zenodo.json

@@ -380,6 +380,11 @@
       "affiliation": "DLR, Germany",
       "name": "Bonnet, Pauline",
       "orcid": "0000-0003-3780-0784"
+    },
+    {
+      "affiliation": "MetOffice, UK",
+      "name": "Munday, Gregory",
+      "orcid": "0000-0003-4750-9923"
     }
   ],
   "description": "ESMValTool: A community diagnostic and performance metrics tool for routine evaluation of Earth system models in CMIP.",

CITATION.cff

@@ -391,6 +391,11 @@ authors:
     family-names: Bonnet
     given-names: Pauline
     orcid: "https://orcid.org/0000-0003-3780-0784"
+  - 
+    affiliation: "MetOffice, UK"
+    family-names: Munday
+    given-names: Gregory
+    orcid: "https://orcid.org/0000-0003-4750-9923"
 
 cff-version: 1.2.0
 date-released: 2023-12-20

doc/sphinx/source/index.rst

@@ -6,11 +6,31 @@
 Welcome to ESMValTool's documentation!
 ======================================
 
+To get a first impression of what ESMValTool and ESMValCore can do for you,
+have a look at our blog posts
+`Analysis-ready climate data with ESMValCore <https://blog.esciencecenter.nl/easy-ipcc-powered-by-esmvalcore-19a0b6366ea7>`_
+and
+`ESMValTool: Recipes for solid climate science <https://blog.esciencecenter.nl/esmvaltool-recipes-for-solid-climate-science-da5b33814f69>`_.
+
+A tutorial is available on https://tutorial.esmvaltool.org.
+
+A series of video lectures has been created by `ACCESS-NRI <https://access-nri.org.au>`_.
+While these are tailored for ACCESS users, they are still very informative.
+
+.. raw:: html
+
+   <iframe width="560" height="315" src="https://www.youtube.com/embed/videoseries?si=pUXrXB8C8bLRfQHY&amp;list=PLFjfi2xLaFpJp59LvDc1upQsj_xzFlFLc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+
+|
+
+For more detailed information, the documentation is available below.
+
+Get in touch! Contact information is available :ref:`here <Support-and-Contact>`.
+
 .. include:: _sidebar.rst.inc
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`search`
-

doc/sphinx/source/recipes/index.rst

@@ -32,6 +32,7 @@ Atmosphere
    :maxdepth: 1
 
    recipe_miles
+   recipe_climate_patterns
    recipe_clouds
    recipe_cmug_h2o
    recipe_crem

doc/sphinx/source/recipes/recipe_climate_patterns.rst

@@ -0,0 +1,107 @@
+.. _recipes_climate_patterns:
+
+Generating Climate Patterns from CMIP6 Models
+=============================================
+
+Overview
+--------
+
+The recipe recipe_climate_patterns generates climate patterns from CMIP6 model
+datasets.
+
+.. note::
+  The regrid setting in the recipe is set to a 2.5x3.75 grid. This is done to
+  match the current resolution in the IMOGEN-JULES model, but can be
+  adjusted with no issues for a finer/coarser patterns grid.
+
+
+Available recipes and diagnostics
+---------------------------------
+
+Recipes are stored in esmvaltool/recipes/
+
+* recipe_climate_patterns.yml
+
+Diagnostics are stored in esmvaltool/diag_scripts/climate_patterns/
+
+* climate_patterns.py: generates climate patterns from input datasets
+* sub_functions.py: set of sub functions to assist with driving scripts
+* plotting.py: contains all plotting functions for driving scripts
+
+
+User settings in recipe
+-----------------------
+
+#. Script climate_patterns.py
+
+   *Required settings for script*
+
+   None
+
+   *Optional settings for script*
+
+   * jules_mode: output jules-specific var names + .nc files
+   * parallelise: parallelise over models or not
+   * area: calculate the patterns globally, or over land only
+
+   *Required settings for variables*
+
+   * short_name
+   * additional_datasets
+
+   *Optional settings for variables*
+
+   None
+
+   *Required settings for preprocessor*
+
+   * monthly_statistics: converts data to mean monthly data
+
+   *Optional settings for preprocessor*
+
+   * regrid: regrids data
+
+
+Variables
+---------
+
+#. Script climate_patterns.py
+
+* tasmax (atmos, monthly, longitude latitude time)
+* tasmin (atmos, monthly, longitude latitude time)
+* tas (atmos, monthly, longitude latitude time)
+* huss (atmos, monthly, longitude latitude time)
+* pr (atmos, monthly, longitude latitude time)
+* sfcWind (atmos, monthly, longitude latitude time)
+* ps (atmos, monthly, longitude latitude time)
+* rsds (atmos, monthly, longitude latitude time)
+* rlds (atmos, monthly, longitude latitude time)
+
+
+Observations and reformat scripts
+---------------------------------
+
+None
+
+References
+----------
+
+* Huntingford, C., Cox, P. An analogue model to derive additional climate
+  change scenarios from existing GCM simulations.
+  Climate Dynamics 16, 575–586 (2000). https://doi.org/10.1007/s003820000067
+
+* Mathison, C. T. et al. A rapid application emissions-to-impacts tool
+  for scenario assessment: Probabilistic Regional Impacts from Model patterns
+  and Emissions (PRIME).
+  EGUsphere [preprint], (2024). https://doi.org/10.5194/egusphere-2023-2932
+
+Example plots
+-------------
+
+.. _fig_climate_patterns_2:
+.. figure::  /recipes/figures/climate_patterns/patterns.png
+   :align:   center
+   :width: 80%
+
+   Patterns generated for CMIP6 models, gridded view. Patterns are shown per
+   variable, for the month of January.

doc/sphinx/source/recipes/recipe_seaborn.rst

@@ -16,11 +16,11 @@ Available recipes and diagnostics
 
 Recipes are stored in recipes/
 
-   * recipe_seaborn.yml
+* recipe_seaborn.yml
 
 Diagnostics are stored in diag_scripts/
 
-   * :ref:`seaborn_diag.py <api.esmvaltool.diag_scripts.seaborn_diag>`
+* :ref:`seaborn_diag.py <api.esmvaltool.diag_scripts.seaborn_diag>`
 
 
 Variables

doc/sphinx/source/recipes/recipe_template.rst.template

@@ -14,11 +14,11 @@ Available recipes and diagnostics
 
 Recipes are stored in esmvaltool/recipes/
 
-    * recipe_<mynewrecipe>.yml
+* recipe_<mynewrecipe>.yml
 
 Diagnostics are stored in esmvaltool/diag_scripts/<mynewdiag>/
 
-    * <mynewdiag.py/.ncl/.r>: one line scription
+* <mynewdiag.py/.ncl/.r>: one line scription
 
 
 User settings in recipe

esmvaltool/config-references.yml

@@ -404,6 +404,11 @@ authors:
     institute: BSC, Spain
     orcid:
     github: emchamarro
+  munday_gregory:
+    name: Munday, Gregory
+    institute: MetOffice, UK
+    orcid: https://orcid.org/0000-0003-4750-9923
+    github: mo-gregmunday
   nikulin_grigory:
     name: Nikulin, Grigory
     institute: SMHI, Sweden

esmvaltool/diag_scripts/aerosols/aod_aeronet_assess.py

@@ -11,10 +11,10 @@
 import matplotlib.pyplot as plt
 import numpy as np
 import scipy
-from aero_utils import add_bounds, extract_pt
 from matplotlib import colors, gridspec
 from numpy import ma
 
+from esmvaltool.diag_scripts.aerosols.aero_utils import add_bounds, extract_pt
 from esmvaltool.diag_scripts.shared import group_metadata, run_diagnostic
 from esmvaltool.diag_scripts.shared._base import get_plot_filename