Fixing the Extras directory #50

ledm · 2020-06-29T14:12:25Z

Pull Request checklist

We appreciate your time and effort to improve the tutorial. Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution.

Before you start

Read CONTRIBUTING.md.
Create an issue to discuss your idea. This allows your contributions to be incorporated into the tutorial.

Tasks

Give this pull request a descriptive title.
If you are contributing to existing lesson materials, please make sure the content conforms to the Lesson development section in CONTRIBUTING.md and does not contain any spelling or grammatical errors.
If you are making a new episode, please make sure the content conforms to the Lesson organization and Lesson formatting sections in CONTRIBUTING.md and does not contain any spelling or grammatical errors.
Preferably Codacy checks pass. Status can be seen below your pull request. If there is an error, click the link to find out why.
Preview changes on your machine before pushing them to GitHub by running make serve, alternatively make docker-serve. Please see the Previewing your changes locally section in CONTRIBUTING.md for installation instructions.
All code instructions have been tested.

If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.

Closes {#47}

hb326 · 2020-06-29T14:53:46Z

_extras/about.md

+
+## ESMValTool 
+
+The Earth System Model Evaluation Tool (ESMValTool) is a community-development that aims at improving diagnosing and understanding of the causes and effects of model biases and inter-model spread. The ESMValTool is open to both users and developers encouraging open exchange of diagnostic source code and evaluation results from the Coupled Model Intercomparison Project (CMIP) ensemble. This will facilitate and improve ESM evaluation beyond the state-of-the-art and aims at supporting the activities within CMIP and at individual modelling centers. We envisage running the ESMValTool routinely on the CMIP model output utilizing observations available through the Earth System Grid Federation (ESGF) in standard formats (obs4MIPs) or made available at ESGF nodes.


Should that be "community development" instead of "community-development"?

hb326 · 2020-06-29T15:00:30Z

_extras/about.md

+
+## ESMValTool 
+
+The Earth System Model Evaluation Tool (ESMValTool) is a community-development that aims at improving diagnosing and understanding of the causes and effects of model biases and inter-model spread. The ESMValTool is open to both users and developers encouraging open exchange of diagnostic source code and evaluation results from the Coupled Model Intercomparison Project (CMIP) ensemble. This will facilitate and improve ESM evaluation beyond the state-of-the-art and aims at supporting the activities within CMIP and at individual modelling centers. We envisage running the ESMValTool routinely on the CMIP model output utilizing observations available through the Earth System Grid Federation (ESGF) in standard formats (obs4MIPs) or made available at ESGF nodes.


Maybe remove the "of" in "... understanding of the causes and effects...".

hb326 · 2020-06-29T15:03:52Z

_extras/about.md

+
+## ESMValTool community.
+
+The ESMValTool community includes scientists and programmers from around the world. 


Do we want to mention numbers here? Would be nice since it shows that it is indeed a community tool, but then we might have to update these numbers on a regular basis...

hb326 · 2020-06-29T15:04:31Z

_extras/about.md

+
+The ESMValTool community includes scientists and programmers from around the world. 
+
+ESMValTool has been used to analyse data 


I think there is some part of the sentence/paragraph missing.

hb326 · 2020-06-29T15:09:19Z

_extras/about.md

+
+## OBS4Mips
+
+In parallel to standardization of model output, the ESGF also hosts observations for Model Intercomparison Projects (obs4MIPs) and reanalyses data (ana4MIPs). obs4MIPs provides open access data sets of satellite data that are comparable in terms of variables, temporal and spatial frequency, and periods to CMIP model output (Taylor et al., 2012). The ESMValTool utilizes these observations and reanalyses from ana4MIPs plus additionally available observations in order to evaluate the models performance. In many diagnostics and metrics, more than one observational data set or meteorological reanalysis is used to assess uncertainties in observations.


Do you mean in the last sentence "... is used to account for uncertainties in observations."?

hb326 · 2020-06-29T15:11:09Z

_extras/about.md

+
+In parallel to standardization of model output, the ESGF also hosts observations for Model Intercomparison Projects (obs4MIPs) and reanalyses data (ana4MIPs). obs4MIPs provides open access data sets of satellite data that are comparable in terms of variables, temporal and spatial frequency, and periods to CMIP model output (Taylor et al., 2012). The ESMValTool utilizes these observations and reanalyses from ana4MIPs plus additionally available observations in order to evaluate the models performance. In many diagnostics and metrics, more than one observational data set or meteorological reanalysis is used to assess uncertainties in observations.
+
+The main idea of the ESMValTool is to provide a broad suite of diagnostics which can be performed easily when new model simulations are run. The suite of diagnostics needs to be broad enough to reflect the diversity and complexity of Earth System Models, but must also be robust enough to be run routinely or semi-operationally. In order the address these challenging objectives the ESMValTool is conceived as a framework which allows community contributions to be bound into a coherent framework.


Maybe rephrase the first sentence to "... when new model simulations become available."?

hb326 · 2020-06-29T15:11:56Z

_extras/about.md

+
+In parallel to standardization of model output, the ESGF also hosts observations for Model Intercomparison Projects (obs4MIPs) and reanalyses data (ana4MIPs). obs4MIPs provides open access data sets of satellite data that are comparable in terms of variables, temporal and spatial frequency, and periods to CMIP model output (Taylor et al., 2012). The ESMValTool utilizes these observations and reanalyses from ana4MIPs plus additionally available observations in order to evaluate the models performance. In many diagnostics and metrics, more than one observational data set or meteorological reanalysis is used to assess uncertainties in observations.
+
+The main idea of the ESMValTool is to provide a broad suite of diagnostics which can be performed easily when new model simulations are run. The suite of diagnostics needs to be broad enough to reflect the diversity and complexity of Earth System Models, but must also be robust enough to be run routinely or semi-operationally. In order the address these challenging objectives the ESMValTool is conceived as a framework which allows community contributions to be bound into a coherent framework.


We have already introduced an abbreviation for "Earth System Models" and could use it here.

hb326 · 2020-06-29T15:12:44Z

_extras/about.md

+
+In parallel to standardization of model output, the ESGF also hosts observations for Model Intercomparison Projects (obs4MIPs) and reanalyses data (ana4MIPs). obs4MIPs provides open access data sets of satellite data that are comparable in terms of variables, temporal and spatial frequency, and periods to CMIP model output (Taylor et al., 2012). The ESMValTool utilizes these observations and reanalyses from ana4MIPs plus additionally available observations in order to evaluate the models performance. In many diagnostics and metrics, more than one observational data set or meteorological reanalysis is used to assess uncertainties in observations.
+
+The main idea of the ESMValTool is to provide a broad suite of diagnostics which can be performed easily when new model simulations are run. The suite of diagnostics needs to be broad enough to reflect the diversity and complexity of Earth System Models, but must also be robust enough to be run routinely or semi-operationally. In order the address these challenging objectives the ESMValTool is conceived as a framework which allows community contributions to be bound into a coherent framework.


Rephrase the last sentence to "In order to address these..."

hb326 · 2020-06-29T15:13:44Z

_extras/about.md

+The main idea of the ESMValTool is to provide a broad suite of diagnostics which can be performed easily when new model simulations are run. The suite of diagnostics needs to be broad enough to reflect the diversity and complexity of Earth System Models, but must also be robust enough to be run routinely or semi-operationally. In order the address these challenging objectives the ESMValTool is conceived as a framework which allows community contributions to be bound into a coherent framework.
+
+## License
+The ESMValTool is released under the Apache License, version 2.0. Citation of the ESMValTool paper (“Software Documentation Paper”) is kindly requested upon use, alongside with the software DOI for ESMValTool (doi:10.5281/zenodo.3401363) and ESMValCore (doi:10.5281/zenodo.3387139) and version number:


Why did you put the Software Documentation Paper in " "? Because it is not actually called this?

Lol, I copied and pasted this entire section directly from the Readthedocs page.

_extras/about.md

hb326 · 2020-06-29T15:17:07Z

_extras/about.md

+
+## Acknowledgements
+
+The technical development work for ESValTool v2.0 was funded by various projects, in particular (1) the Copernicus Climate Change Service (C3S) “Metrics and Access to Global Indices for Climate Projections (C3S-MAGIC)” project; (2) the European Union's Horizon 2020 Framework Programme for Research and Innovation “Infrastructure for the European Network for Earth System Modelling (IS-ENES3)” project under grant agreement no. 824084; (3) the European Union's Horizon 2020 Framework Programme for Research and Innovation “Coordinated Research in Earth Systems and Climate: Experiments, kNowledge, Dissemination and Outreach (CRESCENDO)” project under grant agreement no. 641816; (4) the the European Union's Horizon 2020 Framework Programme for Research and Innovation “PRocess-based climate sIMulation: AdVances in high-resolution modelling and European climate Risk Assessment (PRIMAVERA)” project under grant agreement no. 641727; (5) the Helmholtz Society project “Advanced Earth System Model Evaluation for CMIP (EVal4CMIP)”; (6) project S1 (Diagnosis and Metrics in Climate Models) of the Collaborative Research Centre TRR 181 “Energy Transfer in Atmosphere and Ocean” funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) project no. 274762653; and (7) National Environmental Research Council (NERC) National Capability Science Multi-Centre (NCSMC) funding for the UK, Earth System Modelling project (grant no. NE/N018036/1).


I think "Eval4CMIP" needs a small letter "v" in it.

Also, I copied and pasted this directly from the publication!

ledm · 2020-07-17T10:23:01Z

I think the extras folder would be a good place to list all the people who have worked on the tutorial in the user engagement group. Are we happy to do that or should we just say the "user engagement group"?

… extras

ledm · 2020-07-17T10:48:11Z

I think there was too much text in the about.md page, so I re-wrote it to be clear, simple yet cover enough. (Haven't been able to do a local build to test it though)

_extras/about.md

ledm · 2020-07-17T12:08:35Z

_extras/guide.md

@@ -1,6 +1,78 @@
 ---
 title: "Instructor Notes"
 ---
-FIXME
+
+This page includes some tips, reminders and advice for giving this tutorial.


Probably need a blank line after this?

ledm · 2020-07-17T12:09:48Z

_extras/guide.md

+so that participants will still have time after the reminder to complete 
+setup). 
+
+Plan for the tutorial to last at least two hours (this could vary based on


We know that our tutorial takes two hours, but does this tutorial take two hours as well?

SarahAlidoost

@ledm and @rswamina Thank you, great work. it can be merged.

ledm added 3 commits June 29, 2020 13:24

got started with the about page

312fc37

Removed discussion page

7e98437

added additional text

ccfab63

hb326 reviewed Jun 29, 2020

View reviewed changes

_extras/about.md Outdated Show resolved Hide resolved

hb326 reviewed Jun 29, 2020

View reviewed changes

ledm and others added 8 commits June 30, 2020 13:36

Merge remote-tracking branch 'origin/master' into extras

b16b7bf

Added some basic text to the instructors guide

a1c4d1a

Merge remote-tracking branch 'origin/master' into extras

73c0019

Merge remote-tracking branch 'origin/master' into extras

1095cc7

Merge remote-tracking branch 'origin/master' into extras

f9185c5

changed end of lines

44a9aed

Updating extras with the master

08f4826

Updating my local branch

515fe62

ledm added 2 commits July 17, 2020 11:45

removed the too much text

0e322a5

Merge branch 'extras' of https://github.com/ESMValGroup/tutorial into…

0148146

… extras

ledm commented Jul 17, 2020

View reviewed changes

_extras/about.md Outdated Show resolved Hide resolved

Update _extras/about.md

c9e237a

ledm commented Jul 17, 2020

View reviewed changes

_extras/about.md Outdated Show resolved Hide resolved

Update _extras/about.md

4fb7452

updated guide for instructors

9975c0e

ledm commented Jul 17, 2020

View reviewed changes

ledm requested review from hb326 and SarahAlidoost July 17, 2020 12:11

updated guide for instructors with changes suggested by Lee after review

b2a6dc3

SarahAlidoost approved these changes Jul 17, 2020

View reviewed changes

SarahAlidoost removed the request for review from hb326 July 17, 2020 14:12

rswamina merged commit 8162ad7 into master Jul 17, 2020

rswamina deleted the extras branch July 17, 2020 14:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixing the Extras directory #50

Fixing the Extras directory #50

ledm commented Jun 29, 2020

hb326 Jun 29, 2020

hb326 Jun 29, 2020

hb326 Jun 29, 2020

hb326 Jun 29, 2020

hb326 Jun 29, 2020

hb326 Jun 29, 2020

hb326 Jun 29, 2020

hb326 Jun 29, 2020

hb326 Jun 29, 2020

ledm Jun 30, 2020

hb326 Jun 29, 2020

ledm Jun 30, 2020

ledm commented Jul 17, 2020

ledm commented Jul 17, 2020

ledm Jul 17, 2020

ledm Jul 17, 2020

SarahAlidoost left a comment


		## ESMValTool

		The Earth System Model Evaluation Tool (ESMValTool) is a community-development that aims at improving diagnosing and understanding of the causes and effects of model biases and inter-model spread. The ESMValTool is open to both users and developers encouraging open exchange of diagnostic source code and evaluation results from the Coupled Model Intercomparison Project (CMIP) ensemble. This will facilitate and improve ESM evaluation beyond the state-of-the-art and aims at supporting the activities within CMIP and at individual modelling centers. We envisage running the ESMValTool routinely on the CMIP model output utilizing observations available through the Earth System Grid Federation (ESGF) in standard formats (obs4MIPs) or made available at ESGF nodes.


		## ESMValTool community.

		The ESMValTool community includes scientists and programmers from around the world.


		The ESMValTool community includes scientists and programmers from around the world.

		ESMValTool has been used to analyse data


		## OBS4Mips

		In parallel to standardization of model output, the ESGF also hosts observations for Model Intercomparison Projects (obs4MIPs) and reanalyses data (ana4MIPs). obs4MIPs provides open access data sets of satellite data that are comparable in terms of variables, temporal and spatial frequency, and periods to CMIP model output (Taylor et al., 2012). The ESMValTool utilizes these observations and reanalyses from ana4MIPs plus additionally available observations in order to evaluate the models performance. In many diagnostics and metrics, more than one observational data set or meteorological reanalysis is used to assess uncertainties in observations.


		In parallel to standardization of model output, the ESGF also hosts observations for Model Intercomparison Projects (obs4MIPs) and reanalyses data (ana4MIPs). obs4MIPs provides open access data sets of satellite data that are comparable in terms of variables, temporal and spatial frequency, and periods to CMIP model output (Taylor et al., 2012). The ESMValTool utilizes these observations and reanalyses from ana4MIPs plus additionally available observations in order to evaluate the models performance. In many diagnostics and metrics, more than one observational data set or meteorological reanalysis is used to assess uncertainties in observations.

		The main idea of the ESMValTool is to provide a broad suite of diagnostics which can be performed easily when new model simulations are run. The suite of diagnostics needs to be broad enough to reflect the diversity and complexity of Earth System Models, but must also be robust enough to be run routinely or semi-operationally. In order the address these challenging objectives the ESMValTool is conceived as a framework which allows community contributions to be bound into a coherent framework.


		## Acknowledgements

		The technical development work for ESValTool v2.0 was funded by various projects, in particular (1) the Copernicus Climate Change Service (C3S) “Metrics and Access to Global Indices for Climate Projections (C3S-MAGIC)” project; (2) the European Union's Horizon 2020 Framework Programme for Research and Innovation “Infrastructure for the European Network for Earth System Modelling (IS-ENES3)” project under grant agreement no. 824084; (3) the European Union's Horizon 2020 Framework Programme for Research and Innovation “Coordinated Research in Earth Systems and Climate: Experiments, kNowledge, Dissemination and Outreach (CRESCENDO)” project under grant agreement no. 641816; (4) the the European Union's Horizon 2020 Framework Programme for Research and Innovation “PRocess-based climate sIMulation: AdVances in high-resolution modelling and European climate Risk Assessment (PRIMAVERA)” project under grant agreement no. 641727; (5) the Helmholtz Society project “Advanced Earth System Model Evaluation for CMIP (EVal4CMIP)”; (6) project S1 (Diagnosis and Metrics in Climate Models) of the Collaborative Research Centre TRR 181 “Energy Transfer in Atmosphere and Ocean” funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) project no. 274762653; and (7) National Environmental Research Council (NERC) National Capability Science Multi-Centre (NCSMC) funding for the UK, Earth System Modelling project (grant no. NE/N018036/1).

Fixing the Extras directory #50

Fixing the Extras directory #50

Conversation

ledm commented Jun 29, 2020

Pull Request checklist

Before you start

Tasks

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ledm commented Jul 17, 2020

ledm commented Jul 17, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SarahAlidoost left a comment

Choose a reason for hiding this comment