Skip to content

Commit 8162ad7

Browse files
rswaminarswamina
authored
Merge pull request #50 from ESMValGroup/extras
Fixing the Extras directory with Instructions for tutorial conductors and about pages updated.
2 parents 15e8d88 + b2a6dc3 commit 8162ad7

File tree

5 files changed

+170
-9
lines changed

5 files changed

+170
-9
lines changed

‎_extras/about.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,98 @@
11
---
22
title: About
33
---
4+
5+
## ESMValTool
6+
7+
The Earth System Model Evaluation Tool, ESMValTool, is a python-based
8+
software toolkit built to evaluate models of the Earths climate.
9+
10+
ESMVAlTool is made to be:
11+
12+
- Versatile
13+
- Flexible
14+
- Modular
15+
- Standardised 
16+
- Community driven
17+
18+
The toolkit is built with a sensible and modern code development process.
19+
Where possible, we follow software development best practices,
20+
including code review & monitoring, unit & integration testing,
21+
and fully transparent design decisions.
22+
23+
ESMValTool is open source and available on github, and is written
24+
in PEP8-compliant Python3.
25+
26+
For more details on ESMValTool, please go to:
27+
- [https://esmvaltool.org](ESMValTool home page)
28+
- [https://esmvaltool.readthedocs.io/](ESMValTool Read The Docs page)
29+
30+
31+
## ESMValTool_Tutorial
32+
33+
The ESMValTool tutorial was made to help people learn how to install, use,
34+
and develop ESMValTool.
35+
36+
The tutorial uses the software carpentry format and tools, and can be
37+
followed both independently and in a taught tutorial environment.
38+
39+
The tutorial has been produced by the ESMValTool User Engagement team,
40+
and may be forked, developped and rehosted by other groups.
41+
42+
43+
## License
44+
The ESMValTool is released under the Apache License, version 2.0. Citation of
45+
the ESMValTool paper (“Software Documentation Paper”) is kindly requested upon use,
46+
alongside with the software DOI for ESMValTool (doi:10.5281/zenodo.3401363)
47+
and ESMValCore (doi:10.5281/zenodo.3387139) and version number:
48+
49+
## Citation
50+
51+
Please cite ESMValTool using:
52+
53+
Righi, M., Andela, B., Eyring, V., Lauer, A., Predoi, V., Schlund, M.,
54+
Vegas-Regidor, J., Bock, L., Brötz, B., de Mora, L., Diblen, F., Dreyer, L.,
55+
Drost, N., Earnshaw, P., Hassler, B., Koldunov, N., Little, B., Loosveldt Tomas,
56+
S., and Zimmermann, K.:
57+
Earth System Model Evaluation Tool (ESMValTool) v2.0 – technical overview,
58+
Geosci. Model Dev., 13, 1179–1199, https://doi.org/10.5194/gmd-13-1179-2020,
59+
2020.
60+
61+
Besides the above citation, users are kindly asked to register any journal article
62+
(or other scientific documents) that use the software at the ESMValTool webpage
63+
(http://www.esmvaltool.org/).
64+
65+
Citing the Software Documentation Paper and registering your papers
66+
will serve to document the scientific impact of the Software,
67+
which is of vital importance for securing future funding.
68+
69+
You should consider this an obligation if you have taken advantage of the
70+
ESMValTool, which represents the end product of considerable effort by the
71+
development teams.
72+
73+
74+
## Acknowledgements
75+
76+
The technical development work for ESMValTool v2.0 was funded by various projects,
77+
in particular (1) the Copernicus Climate Change Service (C3S) “Metrics and Access
78+
to Global Indices for Climate Projections (C3S-MAGIC)” project; (2) the
79+
European Union's Horizon 2020 Framework Programme for Research and Innovation
80+
“Infrastructure for the European Network for Earth System Modelling (IS-ENES3)”
81+
project under grant agreement no. 824084; (3) the European Union's Horizon 2020
82+
Framework Programme for Research and Innovation “Coordinated Research in Earth
83+
Systems and Climate: Experiments, kNowledge, Dissemination and Outreach (CRESCENDO)”
84+
project under grant agreement no. 641816; (4) the the European Union's Horizon
85+
2020 Framework Programme for Research and Innovation “PRocess-based climate
86+
sIMulation: AdVances in high-resolution modelling and European climate Risk
87+
Assessment (PRIMAVERA)” project under grant agreement no. 641727; (5) the
88+
Helmholtz Society project “Advanced Earth System Model Evaluation for CMIP
89+
(Eval4CMIP)”; (6) project S1 (Diagnosis and Metrics in Climate Models) of
90+
the Collaborative Research Centre TRR 181 “Energy Transfer in Atmosphere and
91+
Ocean” funded by the Deutsche Forschungsgemeinschaft (DFG, German Research
92+
Foundation) project no. 274762653; and (7) National Environmental Research
93+
Council (NERC) National Capability Science Multi-Centre (NCSMC) funding for
94+
the UK, Earth System Modelling project (grant no. NE/N018036/1).
95+
96+
497
{% include escience_academy.html %}
598
{% include links.md %}

‎_extras/discuss.md‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎_extras/guide.md‎

Lines changed: 77 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,82 @@
11
---
22
title: "Instructor Notes"
33
---
4-
FIXME
4+
5+
This page includes some tips, reminders and advice for giving this tutorial.
6+
7+
## Tutorial Content
8+
9+
Well ahead of the planned tutorial date, please go over the available
10+
tutorial material
11+
in your own time at least once to note specifics such as areas where
12+
your cohort may need extra time, any changes you want to make or
13+
additional examples you would like to include.
14+
15+
If you want to add to or adapt the material, you can create your own copy to
16+
modify by forking the repository. See here for a guide on [how to fork a repository](https://docs.github.com/en/enterprise/2.13/user/articles/fork-a-repo).
17+
18+
Please use our guide for [Contributing](CONTRIBUTING.md) when creating your
19+
own material just in case you would like to add to the current
20+
repository in the future.
21+
22+
Once you are satisified with the material you would like to use and have
23+
an estimate of the time required, please proceed with meeting logistics.
24+
25+
## Meeting Logistics
26+
27+
Decide if the tutorial will be held on site or online. If on site, make
28+
sure of venue availability before finalizing the date. If online, set up connection details.
29+
30+
Once you have agreed to a date, and attendees have signed up, send them an email
31+
with the following information:
32+
- a link to the [pre-tutorial instructions page](setup.md)
33+
- a contact email address so they can post any questions that arise during setup
34+
- venue details (if on site) or meeting connection details (if online).
35+
36+
Also allow for sufficient time to get access to any
37+
accounts etc. which could take more than a few days in some cases (a good
38+
thumb rule is to have the time to send a reminder email a few days after
39+
the first email,
40+
so that participants will still have time after the reminder to complete
41+
setup).
42+
43+
Prepare an estimate for how long the tutorial will last
44+
(this could vary based on
45+
your choice of modules and any changes you have made to the tutorial).
46+
Do include comfort breaks as needed.
47+
48+
If more than one person will be conducting the tutorial, discuss ahead
49+
and decide who will handle each component for a smooth flow of the material.
50+
51+
Remind people a few days before the meeting about the pre-meeting exercises.
52+
53+
If conducting the tutorial on site, confirm room bookings and check for
54+
internet connectivity or firewall issues
55+
at the venue. Coffee and biscuits also usually go down well with participants!
56+
57+
If conducting the tutorial online, have a backup plan for failed or
58+
poor internet connections. This could involve sending participants
59+
some of the material or previously recorded meeting videos ahead of time.
60+
Establish rules for questions, microphone and video usage before starting the
61+
meeting. Send meeting connection details (Zoom/Teams etc.) ahead of time and
62+
the day before the meeting.
63+
64+
Have a feedback form ready if you would like attendees to send you feedback.
65+
Request that they do so at the end of the tutorial and send it out as soon after
66+
the tutorial as possible.
67+
68+
## Tips
69+
70+
- Test all recipes, diagnostics and instructions in advance.
71+
72+
- Make sure you don't have issues with accessing the compute node via VPN
73+
or Wi-Fi.
74+
75+
- Check with your computing service for any planned downtime or potential
76+
interuptions.
77+
78+
- Download a local copy of the data, just in case.
79+
80+
- Decide on one or two advanced mini-tutorials as a stretch goal but don't expect to do all of them.
581

682
{% include links.md %}

‎bin/lesson_check.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
'CONTRIBUTING.md': False,
3232
'LICENSE.md': True,
3333
'README.md': False,
34-
os.path.join('_extras', 'discuss.md'): True,
3534
os.path.join('_extras', 'guide.md'): True,
3635
'index.md': True,
3736
'reference.md': True,

‎bin/lesson_initialize.py‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
'_config.yml',
1515
os.path.join('_episodes', '01-introduction.md'),
1616
os.path.join('_extras', 'about.md'),
17-
os.path.join('_extras', 'discuss.md'),
1817
os.path.join('_extras', 'figures.md'),
1918
os.path.join('_extras', 'guide.md'),
2019
'index.md',

0 commit comments

Comments
 (0)