Skip to content

Commit afa8687

Browse files
author
Remi Kazeroni
committed
Merge branch 'main' into Adding_ESMValTool_elements
2 parents 01eb2ec + 34dfa33 commit afa8687

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+5460
-519
lines changed

‎.codacy.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
exclude_paths:
2+
- assets/css/bootstrap.css
3+
- assets/js/bootstrap.min.js
4+
- assets/js/jquery.min.js

‎.github/ISSUE_TEMPLATE.md‎

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

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is. If this issue is about a specific episode, please provide its link or filename.

‎.github/ISSUE_TEMPLATE/feature_suggestion.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Suggestion
3+
about: Suggest a feature for the tutorial repository
4+
title: ''
5+
labels: enhancement, feature
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature related to a problem? Please describe.**
11+
A clear and concise description of what the problem is.
12+
13+
**Would you be able to help out?**
14+
Would you have the time and skills to implement the solution yourself?

‎.github/ISSUE_TEMPLATE/lesson_contribution.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: New lesson material
3+
about: Develop lessons
4+
title: ''
5+
labels: enhancement, lesson
6+
assignees: ''
7+
8+
---
9+
10+
**Short description of the material**
11+
Add a short description of the material that you would like to add.
12+
13+
**Branch and pull request**
14+
Once you've started working, add the branch (and pull request) link.

‎.github/ISSUE_TEMPLATE/q_and_a.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Question and answer
3+
about: Ask your questions
4+
title: ''
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
**How can we help?**
11+
Please write your questions in this issue. We are here to answer.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,25 @@
1-
Please delete this line and the text below before submitting your contribution.
1+
# Pull Request checklist
22

3-
---
3+
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.
44

5-
Thanks for contributing! If this contribution is for instructor training, please send an email to [email protected] with a link to this contribution so we can record your progress. You’ve completed your contribution step for instructor checkout just by submitting this contribution.
5+
* * *
66

7-
Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact The Carpentries Team at [email protected].
7+
## Before you start
88

9-
---
9+
- [ ] Read [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md).
10+
- [ ] Create an [issue](https://github.com/ESMValGroup/tutorial/issues) to discuss your idea. This allows your contributions to be incorporated into the tutorial.
11+
12+
## Tasks
13+
14+
- [ ] Give this pull request a descriptive title.
15+
- [ ] If you are contributing to existing lesson materials, please make sure the content conforms to the `Lesson development` section in [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md) and does not contain any spelling or grammatical errors.
16+
- [ ] If you are making a new episode, please make sure the content conforms to the `Lesson organization` and `Lesson formatting` sections in [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md) and does not contain any spelling or grammatical errors.
17+
- [ ] Preferably Codacy checks pass. Status can be seen below your pull request. If there is an error, click the link to find out why.
18+
- [ ] 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](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md) for installation instructions.
19+
- [ ] All code instructions have been tested.
20+
21+
If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.
22+
23+
* * *
24+
25+
Closes {Link to the corresponding issue}

‎.github/workflows/build-check-tutorial-site.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Jekyll site CI
2+
3+
on:
4+
push:
5+
# pull_request: # turn on when GA tests need to run on PRs too
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-20.04
10+
steps:
11+
- uses: actions/checkout@v2
12+
- name: Setup Ruby
13+
uses: ruby/[email protected]
14+
with:
15+
ruby-version: 2.7
16+
- name: Cache Ruby deps
17+
uses: actions/cache@v2
18+
with:
19+
path: vendor/bundle
20+
key: ruby-deps-${{ hashFiles('**/Gemfile.lock') }}
21+
restore-keys: |
22+
ruby-deps-
23+
- name: Ruby deps
24+
run: gem install json kramdown jekyll bundler
25+
- name: Setup Python
26+
uses: actions/setup-python@v2
27+
with:
28+
python-version: '3.x'
29+
- name: Python deps
30+
run: pip install pyyaml
31+
- name: Nokogiri deps
32+
run: sudo apt install -y pkg-config libxml2-dev libxslt-dev
33+
- name: Site deps
34+
run: bundle install
35+
- name: Build site
36+
run: bundle exec jekyll build
37+
- name: Check all lessons
38+
run: make lesson-check-all

‎.github/workflows/install-esmvaltool-run-recipes.yml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Test Tutorial Recipes
2+
3+
on:
4+
push:
5+
# pull_request: # turn on for tests to run on PRs
6+
schedule:
7+
- cron: '0 4 * * *'
8+
9+
jobs:
10+
install-esmvaltool-and-run-recipes:
11+
runs-on: "ubuntu-latest"
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: Cache conda
15+
uses: actions/cache@v1
16+
env:
17+
# Increase this value to reset cache if files/recipe_example.yml has not changed
18+
CACHE_NUMBER: 1
19+
with:
20+
path: ~/conda_pkgs_dir
21+
key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles('files/recipe_example.yml') }}
22+
- uses: conda-incubator/setup-miniconda@v2
23+
with:
24+
python-version: "3.9"
25+
miniconda-version: "latest"
26+
channels: conda-forge
27+
- name: Install mamba
28+
shell: bash -l {0}
29+
run: conda install mamba
30+
- name: Install esmvaltool from conda
31+
shell: bash -l {0}
32+
run: mamba install esmvaltool
33+
# this step is currently unnecessary; might be useful depending on config customizations
34+
- name: Get config-user file
35+
shell: bash -l {0}
36+
run: esmvaltool config get_config_user
37+
- name: Run all warming stripes recipes in files/
38+
shell: bash -l {0}
39+
run: |
40+
mkdir ~/esmvaltool_tutorial
41+
cp files/warming_stripes.py ~/esmvaltool_tutorial/
42+
for file in files/recipe_warming_stripes*.yml; do $CONDA/envs/test/bin/esmvaltool run $PWD/$file --offline=False; done

‎.zenodo.json‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
{
2+
"creators": [
3+
{
4+
"affiliation": "NLeSC, Netherlands",
5+
"name": "Alidoost, Fakhereh",
6+
"orcid": "0000-0001-8407-6472"
7+
},
8+
{
9+
"affiliation": "NLeSC, Netherlands",
10+
"name": "Andela, Bouwe",
11+
"orcid": "0000-0001-9005-8940"
12+
},
13+
{
14+
"affiliation": "DLR, Germany",
15+
"name": "Bock, Lisa",
16+
"orcid": "0000-0001-7058-5938"
17+
},
18+
{
19+
"affiliation": "NLeSC, Netherlands",
20+
"name": "Camphuijsen, Jaro",
21+
"orcid": "0000-0002-8928-7831"
22+
},
23+
{
24+
"affiliation": "NLeSC, Netherlands",
25+
"name": "Drost, Niels",
26+
"orcid": "0000-0001-9795-7981"
27+
},
28+
{
29+
"affiliation": "DLR, Germany",
30+
"name": "Hassler, Birgit",
31+
"orcid": "0000-0003-2724-709X"
32+
},
33+
{
34+
"affiliation": "NLeSC, Netherlands",
35+
"name": "Kalverla, Peter",
36+
"orcid": "0000-0002-5025-7862"
37+
},
38+
{
39+
"affiliation": "NLeSC, Netherlands",
40+
"name": "López-Tarifa, Pablo",
41+
"orcid": "0000-0002-4136-1860"
42+
},
43+
{
44+
"affiliation": "PML, UK",
45+
"name": "de Mora, Lee",
46+
"orcid": "0000-0002-5080-3149"
47+
},
48+
{
49+
"affiliation": "LMU, Germany",
50+
"name": "Mueller, Benjamin"
51+
},
52+
{
53+
"affiliation": "URead, UK",
54+
"name": "Predoi, Valeriu",
55+
"orcid": "0000-0002-9729-6578"
56+
},
57+
{
58+
"affiliation": "URead, UK",
59+
"name": "Swaminathan, Ranjini",
60+
"orcid": "0000-0001-5853-2673"
61+
},
62+
{
63+
"affiliation": "NLeSC, Netherlands",
64+
"name": "Verhoeven, Stefan",
65+
"orcid": "0000-0002-5821-2060"
66+
}
67+
],
68+
"description": "ESMValTool 2.0 Tutorial.",
69+
"license": {
70+
"id": "CC-BY-4.0"
71+
},
72+
"title": "ESMValTool Tutorial",
73+
"communities": [
74+
{
75+
"identifier": "is-enes3"
76+
},
77+
{
78+
"identifier": "dlr_de"
79+
},
80+
{
81+
"identifier": "nlesc"
82+
}
83+
],
84+
"grants": [
85+
{
86+
"id": "10.13039/501100000780::776613"
87+
},
88+
{
89+
"id": "10.13039/501100000780::824084"
90+
},
91+
{
92+
"id": "10.13039/501100003246::2300185259"
93+
}
94+
]
95+
}

0 commit comments

Comments
 (0)