Added additional emergent constraints on ECS #1585

schlunma · 2020-03-16T17:25:47Z

Add several emergent constraints (including lots of code for general emergent constraints) for ECS, among them the Volodin (2008) constraint necessary for Lauer et al.

Depends on ESMValGroup/ESMValCore#546 and ESMValGroup/ESMValCore#562.

Tasks

Create an issue to discuss what you are going to do, if you haven't done so already (and add the link at the bottom)
Give this pull request a descriptive title that can be used as a one line summary in a changelog
Make sure your code is composed of functions of no more than 50 lines and uses meaningful names for variables
Circle/CI tests pass. Status can be seen below your pull request. If the tests are failing, click the link to find out why.
Preferably Codacy code quality checks pass, however a few remaining hard to solve Codacy issues are still acceptable. Status can be seen below your pull request. If there is an error, click the link to find out why. If you suspect Codacy may be wrong, please ask by commenting.
Please use yamllint to check that your YAML files do not contain mistakes
(Only if really necessary) Add any additional dependencies needed for the diagnostic script to setup.py, esmvaltool/install/R/r_requirements.txt or esmvaltool/install/Julia/julia_requirements.txt (depending on the language of your script) and also to meta.yaml for conda dependencies (includes Python and others, but not R/Julia)
If new dependencies are introduced, check that the license is compatible with Apache2.0

New recipe/diagnostic

Add documentation for the recipe to the doc/sphinx/source/recipes folder and add a new entry to index.rst
Add provenance information

Closes #1584.

axel-lauer

I tested this branch and it works. The figures produced look fine. What I find confusing is the need fo a file called "ecs_emergent_constraints.yml in your auxiliary_data_dir". Following the instructions given in this pull request, I created such a file and put it into the auxiliary_data_dir specified in config-user.yml. The recipe then crashed as the file could not be found. When copying it to the ESMValTool base directory, the recipe worked. I then tried to remove the key "read_external_file" from the recipe as the documentation says this would be optional. Again, the recipe crashed.

I would therefore strongly suggest to incorporate the content of "ecs_emergent_constraints.yml" into the main recipe (if possible) or introduce default settings that make providing such a file indeed optional.
If this is not possible, the search path for ecs_emergent_constraints.yml would have to be double-checked and a description of how to create the content of this file would have to be added to the documentation.

esmvaltool/recipes/recipe_ecs_constraints.yml

esmvaltool/diag_scripts/emergent_constraints/ecs_scatter.py

bouweandela · 2020-07-10T14:36:23Z

esmvaltool/recipes/recipe_ecs_constraints.yml

+          provenance_authors: ['schlund_manuel']
+          provenance_domains: ['global']
+          provenance_realms: ['atmos']
+          provenance_references: ['gregory04grl']
+          provenance_statistics: ['mean', 'anomaly']
+          provenance_themes: ['phys']


themes and realms is usually included directly under the diagnostic in the recipe, have a look at how it's done in e.g. recipe_perfmetrics_CMIP5.yml or examples/recipe_python.yml. The other attributes are usually set in the code, because they are very closely tied to the diagnostic script.

For the diagnostic univariate_constraint.py it does not make sense to hardcode the provenance information in the header of the recipe or the diagnostic script itself, since it is able to handle arbitrary emergent constraints. E.g., realms could be anything (atmosphere, ocean, land, etc.).

But you will still be the author of the diagnostic script, right?

…ol into add_ecs_constraints

schlunma · 2020-07-14T15:37:36Z

@axel-lauer I have added the contents of the external file to the recipe, so the external file is not necessary anymore. I also addressed the other comments by @bouweandela. Please note that this PR needs a new release of ESMValCore to work.

axel-lauer

Tested the latest version of recipe_ecs_constraints.yml and recipe_ecs_scatter.yml (as this could have been affected by changes to ecs_scatter.ncl). Looks all good! Thanks for moving the config options from the external file to the recipe.

mattiarighi · 2020-07-21T09:43:35Z

I get an error in recipe_ecs_constraints.yml

Traceback (most recent call last):
  File "/work/bd0080/b309057/SOFTWARE/miniconda3/envs/esmvaltool/lib/python3.8/multiprocessing/pool.py", line 125, in worker
    result = (True, func(*args, **kwds))
  File "/work/bd0080/b309057/SOFTWARE/miniconda3/envs/esmvaltool/lib/python3.8/site-packages/esmvalcore/_task.py", line 730, in _run_task
    output_files = task.run()
  File "/work/bd0080/b309057/SOFTWARE/miniconda3/envs/esmvaltool/lib/python3.8/site-packages/esmvalcore/_task.py", line 242, in run
    self.output_files = self._run(input_files)
  File "/work/bd0080/b309057/SOFTWARE/miniconda3/envs/esmvaltool/lib/python3.8/site-packages/esmvalcore/_task.py", line 523, in _run
    raise DiagnosticError(
esmvalcore._task.DiagnosticError: Diagnostic script emergent_constraints/ecs_scatter.py failed with return code 1. See the log in /mnt/lustre02/work/bd0854/b309057/ESMValTool/v2_output/recipe_ecs_constraints_20200721_092906/run/diag_x_volodin_cmip5/ecs_predictor/log.txt

In the log:

Traceback (most recent call last):
  File "/mnt/lustre01/pf/b/b309057/ESMValTool/public/esmvaltool/diag_scripts/emergent_constraints/ecs_scatter.py", line 59, in <module>
    from esmvalcore.cmor import add_plev_from_altitude, add_sigma_factory
ImportError: cannot import name 'add_plev_from_altitude' from 'esmvalcore.cmor' (/work/bd0080/b309057/SOFTWARE/miniconda3/envs/esmvaltool/lib/python3.8/site-
packages/esmvalcore/cmor/__init__.py)

bouweandela · 2020-07-22T12:00:01Z

Yes, see #1585 (comment)

mattiarighi · 2020-07-22T12:05:43Z

@schlunma can you fix this please?

mattiarighi · 2020-07-23T19:08:41Z

I tested successfully both recipes.
@bouweandela if you are ok with this please merge and cherry pick to v2.0.0-release.

bouweandela · 2020-07-24T10:05:30Z

The way the provenance and tags are implemented in these diagnostics is different from how it's normally done and I'm not convinced it's the right way to go, see also #1585 (comment). @mattiarighi Do you want to fix this now, or shall we make an issue so @schlunma can fix it when he's back from holiday?

mattiarighi · 2020-07-24T10:06:59Z

The problem is that this needs to go in the final release because it's part of @axel-lauer's paper.

What about merging it now and opening an issue that @schlunma can take care of when he is back?

mattiarighi · 2020-07-27T15:23:11Z

@bouweandela please cherry-pick in v2.0.0-release.

* Added additional emergent constraints on ECS * Added missing reference * Simplified LTMI calculation using S and D functinos * Fixed codacy issue * Fixed parallel calculation of pressure level widths * Added additional emergent constraints on ECS * Added missing reference * Simplified LTMI calculation using S and D functinos * Fixed codacy issue * Fixed parallel calculation of pressure level widths * Moved additional data from external file to recipe * Add #ESMValTool to header * Fix import path * Fix imports Co-authored-by: Mattia Righi <mattia.righi@dlr.de> Co-authored-by: Bouwe Andela <b.andela@esciencecenter.nl>

bouweandela · 2020-07-27T16:13:47Z

Done!

schlunma added the diagnostic label Mar 16, 2020

schlunma requested a review from axel-lauer March 16, 2020 17:25

schlunma self-assigned this Mar 16, 2020

schlunma mentioned this pull request Mar 16, 2020

Add emergent constraint for ECS of Volodin (2008) #1584

Closed

This comment has been minimized.

Sign in to view

schlunma force-pushed the add_ecs_constraints branch from c1cc073 to 17b54b3 Compare April 28, 2020 10:07

schlunma force-pushed the add_ecs_constraints branch from 17b54b3 to b0dc200 Compare May 15, 2020 14:05

mattiarighi added this to In progress in High priority issues May 22, 2020

mattiarighi removed this from In progress in High priority issues May 22, 2020

schlunma force-pushed the add_ecs_constraints branch from b0dc200 to 100f142 Compare June 19, 2020 10:44

schlunma added 5 commits June 23, 2020 16:13

Added additional emergent constraints on ECS

e8ab909

Added missing reference

edb7b27

Simplified LTMI calculation using S and D functinos

63c21ac

Fixed codacy issue

d71c9c6

Fixed parallel calculation of pressure level widths

eb321d5

schlunma force-pushed the add_ecs_constraints branch from 100f142 to eb321d5 Compare June 23, 2020 14:14

This comment has been minimized.

Sign in to view

schlunma marked this pull request as ready for review June 23, 2020 14:18

This comment has been minimized.

Sign in to view

axel-lauer requested changes Jul 2, 2020

View changes

axel-lauer reviewed Jul 2, 2020

View changes

esmvaltool/recipes/recipe_ecs_constraints.yml Outdated Show resolved Hide resolved

bouweandela reviewed Jul 10, 2020

View changes

esmvaltool/diag_scripts/emergent_constraints/ecs_scatter.py Outdated Show resolved Hide resolved

bouweandela reviewed Jul 10, 2020

View changes

This comment has been minimized.

Sign in to view

schlunma added 5 commits July 14, 2020 10:47

Added additional emergent constraints on ECS

69a7cf1

Added missing reference

29c3217

Simplified LTMI calculation using S and D functinos

ec673d3

Fixed codacy issue

61e6054

Fixed parallel calculation of pressure level widths

26854e5

schlunma mentioned this pull request Jul 14, 2020

--diagnostics option in CLI fails ESMValGroup/ESMValCore#712

Closed

Merge branch 'add_ecs_constraints' of github.com:ESMValGroup/ESMValTo…

3f6034a

…ol into add_ecs_constraints

schlunma mentioned this pull request Jul 14, 2020

Expanded cmor public API ESMValGroup/ESMValCore#714

Merged

9 tasks

schlunma added the requires new ESMValCore release A new release of ESMValCore is needed to solve this issue/merge this pull request.. label Jul 14, 2020

schlunma added 2 commits July 14, 2020 16:34

Moved additional data from external file to recipe

b432079

Merge remote-tracking branch 'public/master' into add_ecs_constraints

7221404

axel-lauer approved these changes Jul 16, 2020

View changes

mattiarighi added 2 commits July 21, 2020 11:28

Merge branch 'master' into add_ecs_constraints

8e41114

Add #ESMValTool to header

4bae90c

bouweandela removed the requires new ESMValCore release A new release of ESMValCore is needed to solve this issue/merge this pull request.. label Jul 22, 2020

Fix import path

9b7978d

mattiarighi approved these changes Jul 23, 2020

View changes

Fix imports

00a1654

mattiarighi mentioned this pull request Jul 27, 2020

Provenance of recipe_ecs_constraints.yml to be improved #1764

Open

mattiarighi merged commit 414ef7a into master Jul 27, 2020
1 check failed

mattiarighi added this to Done in High priority issues via automation Jul 27, 2020

mattiarighi deleted the add_ecs_constraints branch July 27, 2020 15:22

Added additional emergent constraints on ECS #1585

Added additional emergent constraints on ECS #1585

schlunma commented Mar 16, 2020 •

edited

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

axel-lauer left a comment

bouweandela Jul 10, 2020

schlunma Jul 14, 2020

bouweandela Jul 20, 2020

This comment has been minimized.

schlunma commented Jul 14, 2020

axel-lauer left a comment

mattiarighi commented Jul 21, 2020

bouweandela commented Jul 22, 2020

mattiarighi commented Jul 22, 2020

mattiarighi commented Jul 23, 2020 •

edited

bouweandela commented Jul 24, 2020

mattiarighi commented Jul 24, 2020

mattiarighi commented Jul 27, 2020

bouweandela commented Jul 27, 2020

Added additional emergent constraints on ECS #1585

Added additional emergent constraints on ECS #1585

Conversation

schlunma commented Mar 16, 2020 • edited

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

axel-lauer left a comment

Choose a reason for hiding this comment

bouweandela Jul 10, 2020

Choose a reason for hiding this comment

schlunma Jul 14, 2020

Choose a reason for hiding this comment

bouweandela Jul 20, 2020

Choose a reason for hiding this comment

This comment has been minimized.

schlunma commented Jul 14, 2020

axel-lauer left a comment

Choose a reason for hiding this comment

mattiarighi commented Jul 21, 2020

bouweandela commented Jul 22, 2020

mattiarighi commented Jul 22, 2020

mattiarighi commented Jul 23, 2020 • edited

bouweandela commented Jul 24, 2020

mattiarighi commented Jul 24, 2020

mattiarighi commented Jul 27, 2020

bouweandela commented Jul 27, 2020

schlunma commented Mar 16, 2020 •

edited

mattiarighi commented Jul 23, 2020 •

edited