Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Sep 16, 2024
1 parent d594ba6 commit 86331db
Show file tree
Hide file tree
Showing 29 changed files with 14,226 additions and 14,200 deletions.
Binary file added _images/09ab593d19db89b3d8189f756048aa39357afb59299a47c2b2424da7c10a705d.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed _images/159bbf548b1da615f26d931e7cdf80b2cfc07286a41333da8e87a5b0dce7acba.png
View file
Binary file not shown.
Binary file added _images/15d2e048324d6917ef61e0e9e8bea86bc522dd8ab85d009b4c470af195a5c2db.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed _images/5cb719fbe2861be5161020cbb9130079c7c36f82da4df28eef4a2680a50b9b45.png
View file
Binary file not shown.
1,094 changes: 547 additions & 547 deletions _sources/cds-tutorial.ipynb
View file

Large diffs are not rendered by default.

2,890 changes: 1,445 additions & 1,445 deletions _sources/ci-windchill.ipynb
View file

Large diffs are not rendered by default.

39 changes: 20 additions & 19 deletions _sources/erb-outgoing-longwave-radiation.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"metadata": {},
"source": [
"This notebook-tutorial provides a practical introduction to the HIRS dataset available on \n",
"[C3S Earth's radiation budget from 1979 to present derived from satellite observations](https://cds.climate.copernicus.eu/cdsapp#!/dataset/satellite-earth-radiation-budget?tab=overview). \n",
"[C3S Earth's radiation budget from 1979 to present derived from satellite observations](https://cds-beta.climate.copernicus.eu/datasets/satellite-earth-radiation-budget?tab=overview). \n",
"<br>\n",
"We give a short introduction to the ECV Earth Radiation Budget, Outgoing Longwave Radiation (OLR) and provide three use cases of the dataset: plot the time-averaged global distribution of OLR (Use Case 1), calculate global timeseries of OLR (Use Case 2) and plot the Arctic weighted mean timeseries between 1979 and 2019 (Use Case 3).\n",
"We provide step-by-step instructions on data preparation. Use cases come with extensive documentation and each line of code is explained. \n",
Expand Down Expand Up @@ -65,7 +65,7 @@
"tags": []
},
"source": [
"<a id='intro'></a>\n",
"\n",
"\n",
"## 1. Introduction\n",
"\n",
Expand All @@ -77,7 +77,7 @@
"<br>\n",
"\n",
"Please find further information about the dataset as well as the data in the Climate Data Store catalogue entry Earth's Radiation Budget, sections \"Overview\", \"Download data\" and \"Documentation\": \n",
"- [Earth's Radiation Budget from 1979 to present derived from satellite observations](https://cds.climate.copernicus.eu/cdsapp#!/dataset/satellite-earth-radiation-budget?tab=overview)\n",
"- [Earth's Radiation Budget from 1979 to present derived from satellite observations](https://cds-beta.climate.copernicus.eu/datasets/satellite-earth-radiation-budget?tab=overview)\n",
"\n",
"The tutorial video describes the \"Earth Radiation Budget\" Essential Climate Variable and the methods and satellite instruments used to produce the data provided in the CDS catalogue entry: \n",
"- [Tutorial video on the Earth Radiation Budget Essential Climate Variable](https://datastore.copernicus-climate.eu/documents/satellite-earth-radiation-budget/C3S_D312b_Lot1.4.2.5_201902_Tutorial_ECVEarthRadiationBudget_v1.4.mp4)"
Expand All @@ -89,7 +89,7 @@
"tags": []
},
"source": [
"<a id='preparation'></a>\n",
"\n",
"\n",
"## 2. Prerequisites and data preparations\n",
"\n",
Expand Down Expand Up @@ -189,7 +189,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
" <a id='cdsapi'></a>\n",
" \n",
"\n",
"### 2.3 Download data using CDS API\n",
"\n",
Expand All @@ -199,7 +199,7 @@
"\n",
"We will request data from the CDS programmatically with the help of the [CDS API](https://confluence.ecmwf.int/display/CKB/Climate+Data+Store+%28CDS%29+infrastructure+and+API). \n",
"First, we need to manually set the CDS API credentials. To do so, we need to define two variables: URL and KEY. \n",
"To obtain these, first login to the CDS, then visit https://cds.climate.copernicus.eu/api-how-to and copy the string of characters listed after \"key:\". Replace the `#########` below with this string.\n"
"To obtain these, first login to the CDS, then visit https://cds-beta.climate.copernicus.eu/how-to-api and copy the string of characters listed after \"key:\". Replace the `#########` below with this string.\n"
]
},
{
Expand All @@ -208,7 +208,7 @@
"metadata": {},
"outputs": [],
"source": [
"URL = 'https://cds.climate.copernicus.eu/api/v2'\n",
"URL = 'https://cds-beta.climate.copernicus.eu/api'\n",
"KEY = '#########'"
]
},
Expand Down Expand Up @@ -238,8 +238,8 @@
"source": [
"#### Search for data\n",
"\n",
"To search for data, visit the CDS website: https://cds.climate.copernicus.eu/cdsapp#!/home.\n",
"Here you can search for HIRS OLR data using the search bar. The data we need for this use case is the [Earth's Radiation Budget from 1979 to present derived from satellite observations](https://cds.climate.copernicus.eu/cdsapp#!/dataset/satellite-earth-radiation-budget?tab=overview).\n",
"To search for data, visit the CDS website: https://cds-beta.climate.copernicus.eu/.\n",
"Here you can search for HIRS OLR data using the search bar. The data we need for this use case is the [Earth's Radiation Budget from 1979 to present derived from satellite observations](https://cds-beta.climate.copernicus.eu/datasets/satellite-earth-radiation-budget?tab=overview).\n",
"The Earth Radiation Budget (ERB) comprises the quantification of the incoming radiation from the Sun and the outgoing reflected shortwave and emitted longwave radiation. This catalogue entry comprises data from a number of sources."
]
},
Expand Down Expand Up @@ -294,7 +294,8 @@
"c.retrieve(\n",
" 'satellite-earth-radiation-budget',\n",
" {\n",
" 'format': 'zip',\n",
" 'download_format': 'zip',\n",
" 'data_format': 'netcdf_legacy',\n",
" 'origin': 'noaa_ncei_hirs',\n",
" 'variable': 'outgoing_longwave_radiation',\n",
" 'year': ['%04d' % (year) for year in range(1979, 2023)],\n",
Expand Down Expand Up @@ -346,11 +347,11 @@
"tags": []
},
"source": [
"<a id='usecases'></a>\n",
"\n",
"\n",
"## 3. Use Cases\n",
"\n",
"<a id='global-climatology'></a>\n",
"\n",
"\n",
"### **Use case 1**: Climatology of the Outgoing Longwave Radiation (OLR)\n",
"\n",
Expand Down Expand Up @@ -504,7 +505,7 @@
}
},
"source": [
"<a id='timeseries-global'></a>\n",
"\n",
"\n",
"### **Use case 2**: Global time series of the OLR\n",
"\n",
Expand Down Expand Up @@ -623,7 +624,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"<a id='timeseries-arctic'></a>\n",
"\n",
"\n",
"### **Use case 3**: OLR evolution in the Arctic\n",
"\n",
Expand Down Expand Up @@ -709,21 +710,21 @@
"source": [
"## Get more information about Earth Radiation Budget:\n",
"\n",
"- [Earth's radiation budget from 1979 to present derived from satellite observations](https://cds.climate.copernicus.eu/cdsapp#!/dataset/satellite-earth-radiation-budget?tab=overview)\n",
"- [Climate Data Store](https://cds.climate.copernicus.eu/)"
"- [Earth's radiation budget from 1979 to present derived from satellite observations](https://cds-beta.climate.copernicus.eu/datasets/satellite-earth-radiation-budget?tab=overview)\n",
"- [Climate Data Store](https://cds-beta.climate.copernicus.eu/)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"<a id='references'></a>\n",
"\n",
"\n",
"## References\n",
"\n",
"<a id='hansen'></a>Hansen, J., Ruedy, R., Sato, M., & Lo, K., (2010). _Global surface temperature change_. Reviews of Geophysics, 48(4).\n",
"Hansen, J., Ruedy, R., Sato, M., & Lo, K., (2010). _Global surface temperature change_. Reviews of Geophysics, 48(4).\n",
"\n",
"<a id='harrison'></a>Harrison, E.F., Gurney, R. J., Foster, J. L., Gurney, R. J., & Parkinson, C. L. (1993). _Atlas of satellite observations related to global change_. Chapter: Radiation Budget at the top of the atmosphere. Cambridge University Press."
"Harrison, E.F., Gurney, R. J., Foster, J. L., Gurney, R. J., & Parkinson, C. L. (1993). _Atlas of satellite observations related to global change_. Chapter: Radiation Budget at the top of the atmosphere. Cambridge University Press."
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions _sources/glofas-bangladesh-floods.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@
"\n",
"We will request data from the Climate Data Store (CDS) programmatically with the help of the CDS API.\n",
"\n",
"If you have not set up your CDS API credentials with a `~/.cdsapirc` file, it is possible to provide the credentials when initialising the `cdsapi.Client`. To do this we must define the two variables needed to establish a connection: `URL` and `KEY` . The `URL` for the cds api is common and you do not need to modify that field. The `KEY` is string of characters made up of your your personal User ID and CDS API key. To obtain these, first register or login to the CDS (http://cds.climate.copernicus.eu), then visit https://cds.climate.copernicus.eu/api-how-to and copy the string of characters listed after \"key:\". Replace the `#########` below with this string.\n",
"If you have not set up your CDS API credentials with a `~/.cdsapirc` file, it is possible to provide the credentials when initialising the `cdsapi.Client`. To do this we must define the two variables needed to establish a connection: `URL` and `KEY` . The `URL` for the cds api is common and you do not need to modify that field. The `KEY` is string of characters made up of your your personal User ID and CDS API key. To obtain these, first register or login to the CDS (https://cds-beta.climate.copernicus.eu/), then visit https://cds-beta.climate.copernicus.eu/how-to-api and copy the string of characters listed after \"key:\". Replace the `#########` below with this string.\n",
"\n",
"NOTE: If you have set up your cdsapi key using a ~/.cdsapirc you do not need to add your key below."
]
Expand All @@ -166,7 +166,7 @@
"if os.path.isfile(\"~/.cdsapirc\"):\n",
" cdsapi_kwargs = {}\n",
"else:\n",
" URL = 'https://cds.climate.copernicus.eu/api/v2'\n",
" URL = 'https://cds-beta.climate.copernicus.eu/api'\n",
" KEY = '##################################'\n",
" cdsapi_kwargs = {\n",
" 'url': URL,\n",
Expand Down
20 changes: 11 additions & 9 deletions _sources/projections-cmip6.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"This notebook provides a practical introduction on how to access and process [CMIP6 global climate projections](https://cds.climate.copernicus.eu/cdsapp#!/dataset/projections-cmip6?tab=overview) data available in the Climate Data Store (CDS) of the Copernicus Climate Change Service (C3S). The workflow shows how to compute and visualize the output of an ensemble of models for the annual global average temperature between 1850 to 2100. You will use the `historical` experiment for the temporal period 1850 to 2014 and the three scenarios `SSP1-2.6`, `SSP2-4.5` and `SSP5-8.5` for the period from 2015 to 2100.\n",
"This notebook provides a practical introduction on how to access and process [CMIP6 global climate projections](https://cds-beta.climate.copernicus.eu/datasets/projections-cmip6?tab=overview) data available in the Climate Data Store (CDS) of the Copernicus Climate Change Service (C3S). The workflow shows how to compute and visualize the output of an ensemble of models for the annual global average temperature between 1850 to 2100. You will use the `historical` experiment for the temporal period 1850 to 2014 and the three scenarios `SSP1-2.6`, `SSP2-4.5` and `SSP5-8.5` for the period from 2015 to 2100.\n",
"\n",
"For the sake of simplicity, and to facilitate data download, the tutorial will make use of some of the coarser resolution models that have a smaller data size. It is nevertheless only a choice for this exercise and not a recommendation (since ideally all models, including those with highest resolution, should be used). Many more models are available on the CDS, and when calculating an ensemble of models, it is best practice to use as many as possible for a more reliable output. See [here](https://confluence.ecmwf.int/display/CKB/CMIP6%3A+Global+climate+projections#CMIP6:Globalclimateprojections-Models,gridsandpressurelevels) a full list of models included in the CDS-CMIP6 dataset.\n",
"\n",
Expand Down Expand Up @@ -68,7 +68,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"This notebook introduces you to [CMIP6 Global climate projections](https://cds.climate.copernicus.eu/cdsapp#!/dataset/projections-cmip6?tab=overview). The datasets used in the notebook have the following specifications:\n",
"This notebook introduces you to [CMIP6 Global climate projections](https://cds-beta.climate.copernicus.eu/datasets/projections-cmip6?tab=overview). The datasets used in the notebook have the following specifications:\n",
"\n",
"> **Data**: CMIP6 global climate projections of near-surface air temperature <br>\n",
"> **Experiments**: Historical, SSP1-2.6, SSP2-4.5, SSP5-8.5 <br>\n",
Expand Down Expand Up @@ -179,7 +179,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"We will request data from the Climate Data Store (CDS) programmatically with the help of the CDS API. Let us make use of the option to manually set the CDS API credentials. First, you have to define two variables: `URL` and `KEY` which build together your CDS API key. The string of characters that make up your KEY include your personal User ID and CDS API key. To obtain these, first register or login to the CDS (http://cds.climate.copernicus.eu), then visit https://cds.climate.copernicus.eu/api-how-to and copy the string of characters listed after \"key:\". Replace the `#########` below with this string."
"We will request data from the Climate Data Store (CDS) programmatically with the help of the CDS API. Let us make use of the option to manually set the CDS API credentials. First, you have to define two variables: `URL` and `KEY` which build together your CDS API key. The string of characters that make up your KEY include your personal User ID and CDS API key. To obtain these, first register or login to the CDS (https://cds-beta.climate.copernicus.eu), then visit https://cds-beta.climate.copernicus.eu/how-to-api and copy the string of characters listed after \"key:\". Replace the `#########` below with this string."
]
},
{
Expand All @@ -188,7 +188,7 @@
"metadata": {},
"outputs": [],
"source": [
"URL = 'https://cds.climate.copernicus.eu/api/v2'\n",
"URL = 'https://cds-beta.climate.copernicus.eu/api'\n",
"KEY = '##################################'"
]
},
Expand Down Expand Up @@ -242,7 +242,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"> **Note:** Note that these are a selection of the lightest models (in terms of data volume), to facilitate download for the sake of this exercise. There are many [more models available on the CDS](https://cds.climate.copernicus.eu/cdsapp#!/dataset/projections-cmip6?tab=overview)."
"> **Note:** Note that these are a selection of the lightest models (in terms of data volume), to facilitate download for the sake of this exercise. There are many [more models available on the CDS](https://cds-beta.climate.copernicus.eu/datasets/projections-cmip6?tab=overview)."
]
},
{
Expand All @@ -251,14 +251,14 @@
"source": [
"Now we can download the data for each model and experiment sequentially. We will do this separately for the historical experiments and for the various future scenarios, given that they refer to two different time periods.\n",
"\n",
"Before you run the cells below, the terms and conditions on the use of the data need to have been accepted in the CDS. You can view and accept these conditions by logging into the [CDS](http://cds.climate.copernicus.eu), searching for the dataset, then scrolling to the end of the `Download data` section."
"Before you run the cells below, the terms and conditions on the use of the data need to have been accepted in the CDS. You can view and accept these conditions by logging into the [CDS](https://cds-beta.climate.copernicus.eu), searching for the dataset, then scrolling to the end of the `Download data` section."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"> **Note:** For more information about data access through the Climate Data Store, please see the dedicated tutorial [here](./climate_data_store_intro.ipynb)."
"> **Note:** For more information about data access through the Climate Data Store, please see the CDS user guide [here](https://cds-beta.climate.copernicus.eu/user-guide)."
]
},
{
Expand All @@ -275,7 +275,8 @@
" c.retrieve(\n",
" 'projections-cmip6',\n",
" {\n",
" 'format': 'zip',\n",
" 'download_format': 'zip',\n",
" 'data_format': 'netcdf_legacy',\n",
" 'temporal_resolution': 'monthly',\n",
" 'experiment': 'historical',\n",
" 'level': 'single_levels',\n",
Expand All @@ -301,7 +302,8 @@
" c.retrieve(\n",
" 'projections-cmip6',\n",
" {\n",
" 'format': 'zip',\n",
" 'download_format': 'zip',\n",
" 'data_format': 'netcdf_legacy',\n",
" 'temporal_resolution': 'monthly',\n",
" 'experiment': f'{i}',\n",
" 'level': 'single_levels',\n",
Expand Down
Loading

0 comments on commit 86331db

Please sign in to comment.