Skip to content

Commit 8aff948

Browse files
committed
update from develop
1 parent db2b846 commit 8aff948

14 files changed

+202
-230
lines changed

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,4 @@ cython_debug/
159159
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
160160
# and can be added to the global gitignore or merged into this file. For a more nuclear
161161
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
162-
.idea/
163-
164-
_build
162+
#.idea/

C3S–POS–LINE.png

19.8 KB
Loading

LogoLine_EC_Cop_ECMWF.png

160 KB
Loading

README.md

Lines changed: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# c3s-training
2-
32
Master repository for the notebooks to be included in the C3S JupyterBook
4-
5-
## C3SBook
3+
# C3SBook
64

75
This repository contains a book of notebooks generated with Jupyter Book. Below are the instructions for working with this project, including how the structure of the notebooks works and how to perform the build and deploy process of the book.
86

@@ -34,40 +32,10 @@ ghp-import -n -p -f _build/html
3432
# Run our notebooks
3533

3634
In the `notebooks` folder, you'll find all the Jupyter notebooks.
37-
38-
Additionally, there's a `environment.yml` file, containing the conda channels and a list of python dependencies needed for running our notebooks, as presented in the example below
39-
35+
Additionally, there's a `requirements.txt` file included, containing the necessary Python libraries for running the notebooks. You can install all the required libraries by executing the following command in your terminal:
4036

4137
```bash
42-
name: example-environment
43-
channels:
44-
- conda-forge
45-
- defaults
46-
dependencies:
47-
- numpy == 1.26.4
48-
- cdsapi == 0.6.1
49-
- pandas == 2.1.4
50-
- netCDF4 == 1.6.2
51-
- dask == 2023.11.0
52-
- xarray == 2023.6.0
53-
- matplotlib == 3.8.0
54-
- cartopy == 0.22.0
55-
- jupyterlab==4.3.4
56-
- myst-parser==4.0.0
38+
pip install -r requirements.txt
5739
```
5840

59-
The first line of the environment.yml file sets the new environment’s name and you can activate this environment by executing the following commands in your terminal:
60-
61-
62-
```bash
63-
conda env create -f environment.yml
64-
conda activate example-environment
65-
```
66-
To verify that the environment is installed correctly and check the list of environments available you can execute
67-
68-
```bash
69-
conda env list
70-
```
71-
72-
7341
To run the notebooks on your local machine, please refer to [C3S Book:How to run these tutorials ](https://ecmwf-training.github.io/c3s-training/how-to-run-these-tutorials.html) section for detailed instructions.

_config.yml

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Book settings
22
# Learn more at https://jupyterbook.org/customize/config.html
33

4-
title: Copernicus Climate Change Service (C3S) training book
4+
title: Copernicus Climate Change Service (C3S) Training Book
55
author: the Copernicus Climate Change Service (C3S), entrusted to ECMWF (European Centre for Medium-Range Weather Forecasts)
66

77
# Force re-execution of notebooks on each build.
@@ -18,24 +18,19 @@ latex:
1818
# Information about where the book exists on the web
1919
repository:
2020
url: https://github.com/ecmwf-training/C3S-training # Online location of your book
21-
branch: main # Which branch of the repository should be used when creating links (optional)
21+
branch: develop # Which branch of the repository should be used when creating links (optional)
2222

2323
# Add GitHub buttons to your book
2424
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
2525
html:
2626
use_issues_button: true
2727
use_repository_button: true
28-
announcement: "⚠️This is a TEST version, this is not an official website⚠️"
28+
announcement: "⚠️This is a TEST Version, this is not an official website⚠️"
2929
extra_footer: |
3030
<script src="_static/custom.js"></script>
3131
32+
launch_buttons:
33+
binderhub_url: "https://mybinder.org" # The URL for your BinderHub (e.g., https://mybinder.org)
34+
3235
exclude_patterns: ["**.ipynb_checkpoints", "**README.md"]
3336

34-
launch_buttons:
35-
notebook_interface: "jupyterlab" # or "classic"
36-
# WAITING FOR JUPYTERHUB TO BE READY:
37-
# jupyterhub_url: "https://jupyterhub.ecmwf.int"
38-
binderhub_url: "https://mybinder.org" # The URL for your BinderHub (e.g., https://mybinder.org)
39-
# COLAB AND DEEPNOTE NOT COMPATIBLE WITH SUBMODULES
40-
# colab_url: "https://colab.research.google.com" # The URL for Google Colab (e.g., https://colab.research.google.com)
41-
# deepnote_url: "https://deepnote.com" # The URL for Deepnote (e.g., https://deepnote.com)

_toc.yml

Lines changed: 80 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -10,117 +10,100 @@ parts:
1010
title: How to run these tutorials
1111
- caption: Tutorials
1212
chapters:
13-
- file: observations/intro
14-
title: Observations
15-
sections:
16-
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/intro
17-
title: Satellite observations - atmospheric physics
18-
sections:
19-
# ERB
20-
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/erb-outgoing-longwave-radiation
21-
title: Outgoing longwave radiation
22-
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/erb-clara-climatology
23-
title: Analysis of the CLARA Earth radiation budget product
24-
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/erb-ceres-climatology
25-
title: Analysis of the CERES Earth radiation budget product
26-
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/total-solar-irradiance
27-
title: Total solar irradiance
28-
# SRB
29-
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/srb-climatology-and-anomaly
30-
title: Surface radiation budget climatologies and anomalies
31-
# Atmos Humidity and Cloud
32-
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/cloud-cover-climatology
33-
title: Cloud fractional cover climatology
34-
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/total-column-water-vapour-combi
35-
title: Total column water vapour
36-
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/tropospheric-humidity-from-radio-occultation
37-
title: Tropospheric humidity estimates from satellite-based radio occultation measurements
38-
# Precipitation
39-
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/precipitation-giraffe
40-
title: Exploring precipitation information in the GIRAFFE dataset
41-
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/intro
42-
title: Satellite observations - atmospheric composition
43-
sections:
44-
# Ozone
45-
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/total-ozone-columns
46-
title: Total ozone columns
47-
# # GHG
48-
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/greenhouse-gases-level2-products
49-
title: Greenhouse gas level 2 products
50-
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/greenhouse-gases-level3-products
51-
title: Greenhouse gas level 3 products
52-
# # Aerosol
53-
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/aerosol-single-sensor-demonstrator
54-
title: Exploration of the aerosol properties products
55-
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/aerosol-multi-sensor-record
56-
title: A multi-sensor climate data record of aerosol properties
57-
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/intro
58-
title: Satellite observations - hydrology and cryosphere
59-
sections:
60-
# #Surface Water
61-
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/soil-moisture-anomalies
62-
title: Soil moisture anomaly analysis
63-
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/lake-water-level
64-
title: Lake water level timeseries
65-
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/lake-surface-water-temperature
66-
title: Lake surface water temperature analysis
67-
# #Ice Sheets
68-
# - file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/ice-sheet-surface-elevation
69-
# title: Ice sheet surface elevation
70-
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/ice-sheet-velocity
71-
title: Ice sheet velocity
72-
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/ice-sheet-mass-balance
73-
title: Ice sheet mass balance
74-
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/glacier-mass-change
75-
title: Glacier mass change
76-
- file: submodules/c3s-training-submodule-sat-obs-ocean/intro
77-
title: Satellite observations - Ocean
78-
sections:
79-
- file: submodules/c3s-training-submodule-sat-obs-ocean/viewer-for-sealevel-product
80-
title: Sea level and surface currents
81-
- file: submodules/c3s-training-submodule-sat-obs-ocean/ocean-colour-sea-surface-temperature
82-
title: Ocean colour and sea surface temperature
83-
- file: submodules/c3s-training-submodule-sat-obs-land/intro
84-
title: Satellite observations - Land
85-
sections:
86-
- file: submodules/c3s-training-submodule-sat-obs-land/lai-fapar-mean-with-inverse-variance-weights
87-
title: Time average of LAI and fAPAR using inverse variance weights
88-
- file: submodules/c3s-training-submodule-sat-obs-land/exploring-surface-albedo
89-
title: Exploring surface albedo
9013
- file: submodules/c3s-training-submodule-reanalysis/intro
9114
title: Reanalysis
9215
sections:
9316
- file: submodules/c3s-training-submodule-reanalysis/reanalysis-climatology
9417
title: Climatology
9518
- file: submodules/c3s-training-submodule-reanalysis/reanalysis-heatwave
96-
title: Heatwave analysis
19+
title: Heatwave Analysis
9720
- file: submodules/c3s-training-submodule-reanalysis/reanalysis-temp-record
98-
title: Temperature record
99-
- file: submodules/c3s-training-submodule-seasonal-forecast/intro
100-
title: Seasonal forecasts
101-
sections:
102-
- file: submodules/c3s-training-submodule-seasonal-forecast/sf-anomalies
103-
title: Seasonal forecast anomalies
104-
- file: submodules/c3s-training-submodule-seasonal-forecast/sf-verification
105-
title: Seasonal forecast verification
21+
title: Temperature Record
10622
- file: submodules/c3s-training-submodule-projections/intro
107-
title: Climate projections
23+
title: Climate Projections
10824
sections:
10925
- file: submodules/c3s-training-submodule-projections/projections-cmip6
110-
title: Global climate projections (CMIP6)
26+
title: Global Climate Projections (CMIP6)
11127
- file: submodules/c3s-training-submodule-projections/projections-cordex
112-
title: Regional climate projections (CORDEX)
28+
title: Regional Climate Projections (CORDEX)
29+
- file: submodules/c3s-training-submodule-seasonal-forecast/intro
30+
title: Seasonal Forecasts
31+
sections:
32+
- file: submodules/c3s-training-submodule-seasonal-forecast/sf-anomalies
33+
title: Seasonal Forecast Anomalies
34+
- file: submodules/c3s-training-submodule-seasonal-forecast/sf-verification
35+
title: Seasonal Forecast Verification
11336
- file: submodules/c3s-training-submodule-climate-indices/intro
114-
title: Climate indicators
37+
title: Climate Indices
11538
sections:
11639
- file: submodules/c3s-training-submodule-climate-indices/ci-windchill
11740
title: Windchill
118-
- file: submodules/c3s-training-submodule-climate-indices/warm-and-wet-days-indicator
119-
title: Warm and wet days indicator
120-
- file: submodules/c3s-training-submodule-climate-indices/gtsmip-water-levels
121-
title: Coastal water levels and storm surges
41+
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/intro
42+
title: Satellite Observations - Atmospheric Physic
43+
sections:
44+
# ERB
45+
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/erb-outgoing-longwave-radiation
46+
title: Outgoing Longwave Radiation
47+
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/erb-clara-climatology
48+
title: Analysis of the CLARA Earth radiation budget product
49+
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/erb-ceres-climatology
50+
title: Analysis of the CERES Earth radiation budget product
51+
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/total-solar-irradiance
52+
title: Total Solar Irradiance
53+
# SRB
54+
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/srb-climatology-and-anomaly
55+
title: Surface radiation budget climatologies and anomalies
56+
# Atmos Humidity and Cloud
57+
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/total-column-water-vapour-combi
58+
title: Total column water vapour
59+
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/tropospheric-humidity-from-radio-occultation
60+
title: Tropospheric humidity estimates from satellite-based radio occultation measurements
61+
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/cloud-cover-climatology
62+
title: Cloud fractional cover climatology
63+
# Precipitation
64+
- file: submodules/c3s-training-submodule-sat-obs-atmos-physics/precipitation-giraffe
65+
title: Exploring Precipitation information in the GIRAFFE dataset
66+
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/intro
67+
title: Satellite Observations - Atmospheric Composition
68+
sections:
69+
# GHG
70+
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/greenhouse-gases-level2-products
71+
title: Greenhouse Gas Level 2 Products
72+
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/greenhouse-gases-level3-products
73+
title: Greenhouse Gas Level 3 Products
74+
# Aerosol
75+
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/aerosol-single-sensor-demonstrator
76+
title: Aerosol Single Sensor Demonstrator
77+
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/aerosol-multi-sensor-record
78+
title: Aerosol Multi-Sensor Record
79+
# Ozone
80+
- file: submodules/c3s-training-submodule-sat-obs-atmos-comp/total-ozone-columns
81+
title: Total Ozone Columns
82+
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/intro
83+
title: Satellite Observations - Hydrology and Cryosphere
84+
sections:
85+
#Surface Water
86+
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/soil-moisture-anomalies
87+
title: Soil Moisture Anomaly Analysis
88+
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/lake-water-level
89+
title: Lake Water Level Timeseries
90+
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/lake-surface-water-temperature
91+
title: Lake Surface Water Temperature Analysis
92+
#Ice Sheets
93+
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/ice-sheet-surface-elevation
94+
title: Ice Sheet Surface Elevation
95+
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/ice-sheet-velocity
96+
title: Ice Sheet Velocity
97+
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/ice-sheet-mass-balance
98+
title: Ice Sheet Mass Balance
99+
- file: submodules/c3s-training-submodule-sat-obs-hydro-cryo/glacier-mass-change
100+
title: Glacier Mass Change
101+
#- file: submodules/c3s-training-submodule-sat-obs-ocean/intro
102+
# title: Satellite Observations - Ocean
103+
#- file: submodules/c3s-training-submodule-sat-obs-land/intro
104+
# title: Satellite Observations - Land
122105
- file: submodules/copernicus-emergency-service-tutorial/intro
123-
title: Tutorials using Copernicus emergency management service data
106+
title: Tutorials using Copernicus Emergency Management Service data
124107
sections:
125108
- file: submodules/visualising-fwi-for-esotc/visualising-fwi-for-esotc
126109
title: Visualising fire weather index (FWI)
@@ -132,10 +115,10 @@ parts:
132115
- caption: ECMWF
133116
chapters:
134117
- url: https://climate.copernicus.eu/help-and-support
135-
title: Help & support
118+
title: Help & Support
136119
- url: https://climate.copernicus.eu/
137120
title: Copernicus Climate Change Service (C3S)
138121
- url: https://cds.climate.copernicus.eu/
139122
title: Copernicus Climate Data Store (CDS)
140123
- url: https://climate.copernicus.eu/user-learning-services/
141-
title: C3S learning services
124+
title: C3S Learning Services

developer/README.md

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,25 @@
11
# Developer instructions
22

3-
## Updating the submodules
4-
5-
This repository does not automatically update the submodules, this is intentional and is to ensure that
6-
the content is updated periodically and with the approval of the owners.
7-
8-
The following commands will update all the submodules to the current HEAD of the "main" branch.
9-
10-
```
11-
# Change to submodule directory
12-
cd submodules
13-
14-
# Update all submodules
15-
./update-submodules
16-
17-
# If happy with updates, git add, commit and push
18-
git add .
19-
git commit -m"Update submodules"
20-
git push
21-
```
22-
23-
## Build the JupyterBook locally
24-
25-
### Create a JUPYTER-BUILD environment with dependencies installed:
3+
# Create a JUPYTER-BUILD environment with dependencies installed:
264

275
```
286
. ./developer/create-environment-for-build
297
```
308

31-
### Rebuild jupyter book
9+
## Rebuild jupyter book
3210

3311
```
3412
rm -rf _build
3513
jupyter-book build --all .
3614
```
3715

38-
### View local build
16+
## Copy to gh-pages
3917

4018
```
41-
open _build/html/index.html
19+
ghp-import -n -p -f _build/html
4220
```
4321

4422

45-
4623
## Troubleshooting notes
4724

48-
1. Multiple Level 1 Headers (#) in a notebook seems to break the _toc definition of title. It is also bad practice so discourage.
25+
1. Multiple Level 1 Headers (#) in a notebook seems to break the _toc definition of title. It is also bad practice so discourage.

download-notebook.png

64.2 KB
Loading

download-repo-example.png

116 KB
Loading

environment-file-example.png

12.9 KB
Loading

0 commit comments

Comments
 (0)