Skip to content

Commit

Permalink
Merge branch 'main' into cmor-4-lifetime
Browse files Browse the repository at this point in the history
  • Loading branch information
FranziskaWinterstein committed Sep 14, 2023
2 parents c693079 + 4baa8aa commit bd41417
Show file tree
Hide file tree
Showing 14 changed files with 913 additions and 570 deletions.
9 changes: 9 additions & 0 deletions .zenodo.json
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,15 @@
{
"affiliation": "DLR, Germany",
"name": "Bauer, Julian"
},
{
"affiliation": "ACCESS-NRI, Australia",
"name": "Beucher, Romain",
"orcid": "0000-0003-3891-5444"
},
{
"affiliation": "Forschungszentrum Juelich, Germany",
"name": "Benke, Joerg"
}
],
"description": "ESMValCore: A community tool for pre-processing data from Earth system models in CMIP and running analysis scripts.",
Expand Down
9 changes: 9 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,15 @@ authors:
affiliation: "DLR, Germany"
family-names: Bauer
given-names: Julian
-
affiliation: "ACCESS-NRI, Australia"
family-names: Beucher
given-names: Romain
orcid: "https://orcid.org/0000-0003-3891-5444"
-
affiliation: "Forschungszentrum Juelich (FZJ), Germany"
family-names: Benke
given-names: Joerg

cff-version: 1.2.0
date-released: 2023-07-04
Expand Down
72 changes: 36 additions & 36 deletions conda-linux-64.lock

Large diffs are not rendered by default.

50 changes: 33 additions & 17 deletions doc/recipe/preprocessor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1388,7 +1388,7 @@ statistics.

Parameters:
* operator: operation to apply. Accepted values are 'mean', 'median',
'std_dev', 'min', 'max', 'sum' and 'rms'. Default is 'mean'
'std_dev', 'variance', 'min', 'max', 'sum' and 'rms'. Default is 'mean'.

* period: define the granularity of the statistics: get values for the
full period, for each month, day of year or hour of day.
Expand All @@ -1398,6 +1398,12 @@ Parameters:
* seasons: if period 'seasonal' or 'season' allows to set custom seasons.
Default is '[DJF, MAM, JJA, SON]'

.. note::
The 'mean', 'sum' and 'rms' operations over the 'full' period are weighted
by the time coordinate, i.e., the length of the time intervals.
For 'sum', the units of the resulting cube are multiplied by corresponding
time units (e.g., days).

Examples:
* Monthly climatology:

Expand Down Expand Up @@ -1877,23 +1883,26 @@ See also :func:`esmvalcore.preprocessor.meridional_means`.
``area_statistics``
-------------------

This function calculates the average value over a region - weighted by the cell
areas of the region. This function takes the argument, ``operator``: the name
of the operation to apply.
This function calculates statistics over a region.
It takes one argument, ``operator``, which is the name of the operation to
apply.

This function can be used to apply several different operations in the
horizontal plane: mean, standard deviation, median, variance, minimum, maximum and root mean square.
horizontal plane: mean, sum, standard deviation, median, variance, minimum,
maximum and root mean square.
The operations mean, sum and root mean square are area weighted.
For sums, the units of the resulting cubes are multiplied by m :math:`^2`.

Note that this function is applied over the entire dataset. If only a specific
region, depth layer or time period is required, then those regions need to be
removed using other preprocessor operations in advance.
Note that this function is applied over the entire dataset.
If only a specific region, depth layer or time period is required, then those
regions need to be removed using other preprocessor operations in advance.

This function requires a cell area `cell measure`_, unless the coordinates of the
input data are regular 1D latitude and longitude coordinates so the cell areas
can be computed.
The required supplementary variable, either ``areacella`` for atmospheric variables
or ``areacello`` for ocean variables, can be attached to the main dataset
as described in :ref:`supplementary_variables`.
This function requires a cell area `cell measure`_, unless the coordinates of
the input data are regular 1D latitude and longitude coordinates so the cell
areas can be computed.
The required supplementary variable, either ``areacella`` for atmospheric
variables or ``areacello`` for ocean variables, can be attached to the main
dataset as described in :ref:`supplementary_variables`.

.. deprecated:: 2.8.0
The optional ``fx_variables`` argument specifies the fx variables that the user
Expand Down Expand Up @@ -2025,15 +2034,22 @@ Takes arguments:
be performed must be one-dimensional, as multidimensional coordinates
are not supported in this preprocessor.

The 'mean', 'sum' and 'rms' operations are weighted by the corresponding
coordinate bounds.
For 'sum', the units of the resulting cube will be multiplied by
corresponding coordinate units.

See also :func:`esmvalcore.preprocessor.axis_statistics`.


``depth_integration``
---------------------

This function integrates over the depth dimension. This function does a
weighted sum along the `z`-coordinate, and removes the `z` direction of the
output cube. This preprocessor takes no arguments.
This function integrates over the depth dimension.
This function does a weighted sum along the `z`-coordinate, and removes the `z`
direction of the output cube.
This preprocessor takes no arguments.
The units of the resulting cube are multiplied by the `z`-coordinate units.

See also :func:`esmvalcore.preprocessor.depth_integration`.

Expand Down
40 changes: 20 additions & 20 deletions esmvalcore/config/extra_facets/cmip3-institutes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,23 @@
'cccma_cgcm3_1':
'*':
'*':
institute: ['CCCMA']
institute: ['CCCMA', 'CCCma']
'cccma_cgcm3_1_t63':
'*':
'*':
institute: ['CCCMA']
institute: ['CCCMA', 'CCCma']
'CCSM3':
'*':
'*':
institute: ['NCAR']
'CGCM3-1-T47':
'*':
'*':
institute: ['CCCMA']
institute: ['CCCMA', 'CCCma']
'CGCM3-1-T63':
'*':
'*':
institute: ['CCCMA']
institute: ['CCCMA', 'CCCma']
'CM2':
'*':
'*':
Expand All @@ -42,39 +42,39 @@
'CM3':
'*':
'*':
institute: ['CNRM', 'INM']
institute: ['CNRM', 'INM', 'CNRM_CERFACS']
'CM4':
'*':
'*':
institute: ['IPSL']
'cnrm_cm3':
'*':
'*':
institute: ['CNRM']
institute: ['CNRM', 'CNRM_CERFACS']
'csiro_mk3_0':
'*':
'*':
institute: ['CSIRO']
institute: ['CSIRO', 'CSIRO-QCCCE']
'csiro_mk3_5':
'*':
'*':
institute: ['CSIRO']
institute: ['CSIRO', 'CSIRO-QCCCE']
'ECHAM4':
'*':
'*':
institute: ['INGV']
'ECHAM5':
'*':
'*':
institute: ['MPIM']
institute: ['MPIM', 'MPI-M']
'ECHO-G':
'*':
'*':
institute: ['MIUB-KMA']
'FGOALS-G1-0':
'*':
'*':
institute: ['LASG']
institute: ['LASG', 'LASG-IAP']
'gfdl_cm2_0':
'*':
'*':
Expand All @@ -86,27 +86,27 @@
'GISS-AOM':
'*':
'*':
institute: ['NASA']
institute: ['NASA', 'NASA-GISS']
'GISS-EH':
'*':
'*':
institute: ['NASA']
institute: ['NASA', 'NASA-GISS']
'GISS-ER':
'*':
'*':
institute: ['NASA']
institute: ['NASA', 'NASA-GISS']
'giss_aom':
'*':
'*':
institute: ['NASA']
institute: ['NASA', 'NASA-GISS']
'giss_model_e_h':
'*':
'*':
institute: ['NASA']
institute: ['NASA', 'NASA-GISS']
'giss_model_e_r':
'*':
'*':
institute: ['NASA']
institute: ['NASA', 'NASA-GISS']
'HADCM3':
'*':
'*':
Expand All @@ -118,7 +118,7 @@
'iap_fgoals1_0_g':
'*':
'*':
institute: ['LASG']
institute: ['LASG', 'LASG-IAP']
'ingv_echam4':
'*':
'*':
Expand Down Expand Up @@ -154,15 +154,15 @@
'MK3':
'*':
'*':
institute: ['CSIRO']
institute: ['CSIRO', 'CSIRO-QCCCE']
'MK3-5':
'*':
'*':
institute: ['CSIRO']
institute: ['CSIRO', 'CSIRO-QCCCE']
'mpi_echam5':
'*':
'*':
institute: ['MPIM']
institute: ['MPIM', 'MPI-M']
'mri_cgcm2_3_2a':
'*':
'*':
Expand Down
Loading

0 comments on commit bd41417

Please sign in to comment.