Merge branch 'main' into Adding_ESMValTool_elements

.codacy.yml

@@ -0,0 +1,4 @@
+exclude_paths:
+  - assets/css/bootstrap.css
+  - assets/js/bootstrap.min.js
+  - assets/js/jquery.min.js

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,11 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+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

@@ -0,0 +1,14 @@
+---
+name: Suggestion
+about: Suggest a feature for the tutorial repository
+title: ''
+labels: enhancement, feature
+assignees: ''
+
+---
+
+**Is your feature related to a problem? Please describe.**
+A clear and concise description of what the problem is.
+
+**Would you be able to help out?**
+Would you have the time and skills to implement the solution yourself?

.github/ISSUE_TEMPLATE/lesson_contribution.md

@@ -0,0 +1,14 @@
+---
+name: New lesson material
+about: Develop lessons
+title: ''
+labels: enhancement, lesson
+assignees: ''
+
+---
+
+**Short description of the material**
+Add a short description of the material that you would like to add.
+
+**Branch and pull request**
+Once you've started working, add the branch (and pull request) link.

.github/ISSUE_TEMPLATE/q_and_a.md

@@ -0,0 +1,11 @@
+---
+name: Question and answer
+about: Ask your questions
+title: ''
+labels: question
+assignees: ''
+
+---
+
+**How can we help?**
+Please write your questions in this issue. We are here to answer.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,9 +1,25 @@
-Please delete this line and the text below before submitting your contribution.
+# 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.
 
-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.  
+* * *
 
-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].  
+## Before you start
 
----
+- [ ] Read [CONTRIBUTING.md](https://github.com/ESMValGroup/tutorial/blob/master/CONTRIBUTING.md).
+- [ ] Create an [issue](https://github.com/ESMValGroup/tutorial/issues) 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](https://github.com/ESMValGroup/tutorial/blob/master/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](https://github.com/ESMValGroup/tutorial/blob/master/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](https://github.com/ESMValGroup/tutorial/blob/master/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 {Link to the corresponding issue}

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

@@ -0,0 +1,38 @@
+name: Jekyll site CI
+
+on:
+  push:
+  # pull_request:  # turn on when GA tests need to run on PRs too
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Ruby
+      uses: ruby/[email protected]
+      with:
+        ruby-version: 2.7
+    - name: Cache Ruby deps
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ruby-deps-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ruby-deps-
+    - name: Ruby deps
+      run: gem install json kramdown jekyll bundler
+    - name: Setup Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
+    - name: Python deps
+      run: pip install pyyaml
+    - name: Nokogiri deps
+      run: sudo apt install -y pkg-config libxml2-dev libxslt-dev
+    - name: Site deps
+      run: bundle install
+    - name: Build site
+      run: bundle exec jekyll build
+    - name: Check all lessons
+      run: make lesson-check-all

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

@@ -0,0 +1,42 @@
+name: Test Tutorial Recipes
+
+on:
+  push:
+  # pull_request:  # turn on for tests to run on PRs
+  schedule:
+    - cron: '0 4 * * *'
+
+jobs:
+  install-esmvaltool-and-run-recipes:
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cache conda
+        uses: actions/cache@v1
+        env:
+          # Increase this value to reset cache if files/recipe_example.yml has not changed
+          CACHE_NUMBER: 1
+        with:
+          path: ~/conda_pkgs_dir
+          key: ${{ runner.os }}-conda-${{ env.CACHE_NUMBER }}-${{ hashFiles('files/recipe_example.yml') }}
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          python-version: "3.9"
+          miniconda-version: "latest"
+          channels: conda-forge
+      - name: Install mamba
+        shell: bash -l {0}
+        run: conda install mamba
+      - name: Install esmvaltool from conda
+        shell: bash -l {0}
+        run: mamba install esmvaltool
+      # this step is currently unnecessary; might be useful depending on config customizations
+      - name: Get config-user file
+        shell: bash -l {0}
+        run: esmvaltool config get_config_user
+      - name: Run all warming stripes recipes in files/
+        shell: bash -l {0}
+        run: |
+          mkdir ~/esmvaltool_tutorial
+          cp files/warming_stripes.py ~/esmvaltool_tutorial/
+          for file in files/recipe_warming_stripes*.yml; do $CONDA/envs/test/bin/esmvaltool run $PWD/$file --offline=False; done

.zenodo.json

@@ -0,0 +1,95 @@
+{
+    "creators": [
+        {
+            "affiliation": "NLeSC, Netherlands",
+            "name": "Alidoost, Fakhereh",
+            "orcid": "0000-0001-8407-6472"
+        },
+        {
+            "affiliation": "NLeSC, Netherlands",
+            "name": "Andela, Bouwe",
+            "orcid": "0000-0001-9005-8940"
+        },
+        {
+            "affiliation": "DLR, Germany",
+            "name": "Bock, Lisa",
+            "orcid": "0000-0001-7058-5938"
+        },
+        {
+            "affiliation": "NLeSC, Netherlands",
+            "name": "Camphuijsen, Jaro",
+            "orcid": "0000-0002-8928-7831"
+        },
+        {
+            "affiliation": "NLeSC, Netherlands",
+            "name": "Drost, Niels",
+            "orcid": "0000-0001-9795-7981"
+        },
+        {
+            "affiliation": "DLR, Germany",
+            "name": "Hassler, Birgit",
+            "orcid": "0000-0003-2724-709X"
+        },
+        {
+            "affiliation": "NLeSC, Netherlands",
+            "name": "Kalverla, Peter",
+            "orcid": "0000-0002-5025-7862"
+        },
+        {
+            "affiliation": "NLeSC, Netherlands",
+            "name": "López-Tarifa, Pablo",
+            "orcid": "0000-0002-4136-1860"
+        },
+        {
+            "affiliation": "PML, UK",
+            "name": "de Mora, Lee",
+            "orcid": "0000-0002-5080-3149"
+        },
+        {
+            "affiliation": "LMU, Germany",
+            "name": "Mueller, Benjamin"
+        },
+        {
+            "affiliation": "URead, UK",
+            "name": "Predoi, Valeriu",
+            "orcid": "0000-0002-9729-6578"
+        },
+        {
+            "affiliation": "URead, UK",
+            "name": "Swaminathan, Ranjini",
+            "orcid": "0000-0001-5853-2673"
+        },
+        {
+            "affiliation": "NLeSC, Netherlands",
+            "name": "Verhoeven, Stefan",
+            "orcid": "0000-0002-5821-2060"
+        }
+    ],
+    "description": "ESMValTool 2.0 Tutorial.",
+    "license": {
+        "id": "CC-BY-4.0"
+    },
+    "title": "ESMValTool Tutorial",
+    "communities": [
+        {
+            "identifier": "is-enes3"
+        },
+        {
+            "identifier": "dlr_de"
+        },
+        {
+            "identifier": "nlesc"
+        }
+    ],
+    "grants": [
+        {
+            "id": "10.13039/501100000780::776613"
+        },
+        {
+            "id": "10.13039/501100000780::824084"
+        },
+        {
+            "id": "10.13039/501100003246::2300185259"
+        }
+    ]
+}

CITATION.cff

@@ -0,0 +1,82 @@
+# YAML 1.2
+---
+abstract: "ESMValTool 2.0 Tutorial."
+
+authors:
+  -
+    affiliation: "NLeSC, Netherlands"
+    family-names: Alidoost
+    given-names: Fakhereh
+    orcid: "https://orcid.org/0000-0001-8407-6472"
+  -
+    affiliation: "NLeSC, Netherlands"
+    family-names: Andela
+    given-names: Bouwe
+    orcid: "https://orcid.org/0000-0001-9005-8940"
+  -
+    affiliation: "DLR, Germany"
+    family-names: Bock
+    given-names: Lisa
+    orcid: "https://orcid.org/0000-0001-7058-5938"
+  -
+    affiliation: "NLeSC, Netherlands"
+    family-names: Camphuijsen
+    given-names: Jaro
+    orcid: "https://orcid.org/0000-0002-8928-7831"
+  -
+    affiliation: "NLeSC, Netherlands"
+    family-names: Drost
+    given-names: Niels
+    orcid: "https://orcid.org/0000-0001-9795-7981"
+  -
+    affiliation: "DLR, Germany"
+    family-names: Hassler
+    given-names: Birgit
+    orcid: "https://orcid.org/0000-0003-2724-709X"
+  -
+    affiliation: "NLeSC, Netherlands"
+    family-names: Kalverla
+    given-names: Peter
+    orcid: "https://orcid.org/0000-0002-5025-7862"
+  -
+    affiliation: "NLeSC, Netherlands"
+    family-names: López-Tarifa
+    given-names: Pablo
+    orcid: "https://orcid.org/0000-0002-4136-1860"
+  -
+    affiliation: "PML, UK"
+    name-particle: de
+    family-names: Mora
+    given-names: Lee
+    orcid: "https://orcid.org/0000-0002-5080-3149"
+  -
+    affiliation: "LMU, Germany"
+    family-names: Mueller
+    given-names: Benjamin
+  -
+    affiliation: "URead, UK"
+    family-names: Predoi
+    given-names: Valeriu
+    orcid: "https://orcid.org/0000-0002-9729-6578"
+  -
+    affiliation: "URead, UK"
+    family-names: Swaminathan
+    given-names: Ranjini
+    orcid: "https://orcid.org/0000-0001-5853-2673"
+  -
+    affiliation: "NLeSC, Netherlands"
+    family-names: Verhoeven
+    given-names: Stefan
+    orcid: "https://orcid.org/0000-0002-5821-2060"
+cff-version: "1.0.3"
+date-released: 2020-08-06
+doi: "10.5281/zenodo.3974591"
+license: "CC-BY-4.0"
+message: "If you use this tutorial, please cite it using these metadata."
+repository-code: "https://github.com/ESMValGroup/ESMValTool_Tutorial/"
+title: "ESMValTool Tutorial"
+keywords:
+  - "Earth System Model Validation"
+  - "Climate Science"
+version: "v1.0.0"
+...

CODE_OF_CONDUCT.md

@@ -1,11 +1,5 @@
----
-layout: page
-title: "Contributor Code of Conduct"
----
-As contributors and maintainers of this project,
-we pledge to follow the [Carpentry Code of Conduct][coc].
+# Contributor Code of Conduct
 
-Instances of abusive, harassing, or otherwise unacceptable behavior
-may be reported by following our [reporting guidelines][coc-reporting].
-
-{% include links.md %}
+As contributors and maintainers of this tutorial,
+we pledge to follow the ESMValTool
+[Code of Conduct](https://github.com/ESMValGroup/ESMValTool/blob/main/CODE_OF_CONDUCT.md).