Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
EddyCMWF committed Dec 9, 2024
1 parent 44aaa57 commit ffb984f
Show file tree
Hide file tree
Showing 24 changed files with 42 additions and 60 deletions.
13 changes: 3 additions & 10 deletions _sources/cds-tutorial.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@
"metadata": {},
"source": [
"There are two ways to access data from the Copernicus Climate Data Store (CDS):\n",
"* [interactively](#access_manual) via the CDS web interface, or\n",
"* [programmatically](#access_programmatic) with the CDS API"
"* interactively via the CDS web interface, or\n",
"* programmatically with the CDS API"
]
},
{
Expand Down Expand Up @@ -196,7 +196,7 @@
"**Note:** You need to be logged into the ADS portal and you have to accept the Terms and Conditions of the dataset before being able to download data.\n",
"\n",
"\n",
"You will need the `Show API request`, if you want to request data programmatically. See [Section 2.2](#access_programmatic) for further information. You will need the `Show Toolbox request` if you want to request data via the CDS Toolbox. Learn more about the CDS Toolbox [here](https://cds.climate.copernicus.eu/cdsapp#!/toolbox).\n"
"You will need the `Show API request`, if you want to request data programmatically. See Section 2.2 for further information. You will need the `Show Toolbox request` if you want to request data via the CDS Toolbox. Learn more about the CDS Toolbox [here](https://cds.climate.copernicus.eu/cdsapp#!/toolbox).\n"
]
},
{
Expand Down Expand Up @@ -435,13 +435,6 @@
"#### Example: **ERA5-Land hourly data from 1950 to present**"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"> Data used in [113_c3s_climate_indices](./113_c3s_climate_indices.ipynb)"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand Down
11 changes: 2 additions & 9 deletions _sources/ecv-notebooks/erb-outgoing-longwave-radiation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@
"December 2018. The maximum values of the OLR are found in the tropics and it decreases toward the\n",
"poles. The relative minimum near the equator, in yellow colour, corresponds to the ITCZ and the\n",
"convection areas, where persistent and relatively high cloud cover reduces the LW radiation at the\n",
"TOA. Antarctica is cooler than the corresponding northern latitudes ([Harrison et al.](#harrison))."
"TOA. Antarctica is cooler than the corresponding northern latitudes (Harrison et al.)."
]
},
{
Expand Down Expand Up @@ -684,7 +684,7 @@
"**Figure 3**, shows the evolution of the OLR in the Arctic region [70°N-90°N] for the period 1979-2019\n",
"also using a yearly rolling mean. From the image, we can infer an increase in the OLR in the Arctic\n",
"region with time. This increase is strongly marked as from 1998 and in line with the increase of\n",
"temperature in the Arctic ([Hansen et al, 2010](#hansen)), while the relative stability of the first part of the time\n",
"temperature in the Arctic (Hansen et al, 2010), while the relative stability of the first part of the time\n",
"series is more difficult to interpret due to the major volcanic eruptions in this period."
]
},
Expand All @@ -710,13 +710,6 @@
"\n",
"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."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"[Back to top the Page](#page-top)"
]
}
],
"metadata": {
Expand Down
4 changes: 2 additions & 2 deletions _sources/ecv-notebooks/srb-climatology-and-anomaly.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1996,7 +1996,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Please note that you need to open the dataset to be able to execute this usecase, as described in the previous section [\"Load dataset\"](#load).\n",
"Please note that you need to open the dataset to be able to execute this usecase, as described in the previous load data section.\n",
"\n",
"The spatial resolution of the CLARA-A3 radiation dataset is 0.25ºx0.25º that is roughly equal to 25x25 km. With this resolution, it is possible to conduct a regional analysis using the CLARA-A3 radiation datasets. Furthermore, we can use the CLARA-A3 radiation datasets to investigate recent meteorological events. This could be a research project for a student or provide complementary information on a special event, e.g., the analysis of recent heat waves. In recent years, a high number of heat waves appeared in Europe. Particularly interesting is the summer 2003."
]
Expand Down Expand Up @@ -2049,7 +2049,7 @@
},
{
"cell_type": "code",
"execution_count": null,
"execution_count": 16,
"metadata": {},
"outputs": [
{
Expand Down
6 changes: 3 additions & 3 deletions _sources/reanalysis-climatology.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1476,7 +1476,7 @@
"source": [
"## 4. Calculate monthly climatology and anomalies\n",
"\n",
"We will now calculate the monthly climatology of near-surface air temperature for the period 1991 to 2020. We will also view the anomalies with respect to the climatology for a particular month. To do this, we return to the data array created at the end of [section 1](#search_download).\n",
"We will now calculate the monthly climatology of near-surface air temperature for the period 1991 to 2020. We will also view the anomalies with respect to the climatology for a particular month. To do this, we return to the data array created at the end of section 1.\n",
"\n",
"We first create again a temporal subset for the period 1991 to 2020, but this time keeping the monthly temporal resolution."
]
Expand Down Expand Up @@ -1811,7 +1811,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"We will repeat the steps in [section 1](#search_download) to read the data into an xarray data array:"
"We will repeat the steps in section 1 to read the data into an xarray data array:"
]
},
{
Expand All @@ -1829,7 +1829,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"We will also repeat the steps in [section 1](#search_download) to convert the values from degrees Kelvin to Celsius:"
"We will also repeat the steps in section 1 to convert the values from degrees Kelvin to Celsius:"
]
},
{
Expand Down
6 changes: 3 additions & 3 deletions _sources/sf-anomalies.ipynb

Large diffs are not rendered by default.

11 changes: 4 additions & 7 deletions cds-tutorial.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=a3416100" />
<link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-thebe.css?v=4fa983c6" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />

Expand Down Expand Up @@ -526,8 +526,8 @@ <h2>About<a class="headerlink" href="#about" title="Link to this heading">#</a><
<h2>Data retrieval<a class="headerlink" href="#data-retrieval" title="Link to this heading">#</a></h2>
<p>There are two ways to access data from the Copernicus Climate Data Store (CDS):</p>
<ul class="simple">
<li><p><a class="reference internal" href="#access_manual"><span class="xref myst">interactively</span></a> via the CDS web interface, or</p></li>
<li><p><a class="reference internal" href="#access_programmatic"><span class="xref myst">programmatically</span></a> with the CDS API</p></li>
<li><p>interactively via the CDS web interface, or</p></li>
<li><p>programmatically with the CDS API</p></li>
</ul>
<section id="access-data-interactively-via-the-cds-web-interface">
<h3>Access data interactively via the CDS web interface<a class="headerlink" href="#access-data-interactively-via-the-cds-web-interface" title="Link to this heading">#</a></h3>
Expand All @@ -550,7 +550,7 @@ <h4>Submit the <em>Download data</em> form<a class="headerlink" href="#submit-th
</ul>
<p>At the end of the <code class="docutils literal notranslate"><span class="pre">&quot;Download</span> <span class="pre">data&quot;</span> <span class="pre">form</span></code>, you get three options: <code class="docutils literal notranslate"><span class="pre">Show</span> <span class="pre">API</span> <span class="pre">request</span></code>, <code class="docutils literal notranslate"><span class="pre">Show</span> <span class="pre">Toolbox</span> <span class="pre">request</span></code> and <code class="docutils literal notranslate"><span class="pre">Submit</span> <span class="pre">Form</span></code>. If you want to download the data interactively, the data requests will be executed as soon as you click on the <code class="docutils literal notranslate"><span class="pre">Submit</span> <span class="pre">Form</span></code> button.</p>
<p><strong>Note:</strong> You need to be logged into the ADS portal and you have to accept the Terms and Conditions of the dataset before being able to download data.</p>
<p>You will need the <code class="docutils literal notranslate"><span class="pre">Show</span> <span class="pre">API</span> <span class="pre">request</span></code>, if you want to request data programmatically. See <a class="reference internal" href="#access_programmatic"><span class="xref myst">Section 2.2</span></a> for further information. You will need the <code class="docutils literal notranslate"><span class="pre">Show</span> <span class="pre">Toolbox</span> <span class="pre">request</span></code> if you want to request data via the CDS Toolbox. Learn more about the CDS Toolbox <a class="reference external" href="https://cds.climate.copernicus.eu/cdsapp#!/toolbox">here</a>.</p>
<p>You will need the <code class="docutils literal notranslate"><span class="pre">Show</span> <span class="pre">API</span> <span class="pre">request</span></code>, if you want to request data programmatically. See Section 2.2 for further information. You will need the <code class="docutils literal notranslate"><span class="pre">Show</span> <span class="pre">Toolbox</span> <span class="pre">request</span></code> if you want to request data via the CDS Toolbox. Learn more about the CDS Toolbox <a class="reference external" href="https://cds.climate.copernicus.eu/cdsapp#!/toolbox">here</a>.</p>
<div class="alert alert-block alert-success">
<b>NOTE</b>: <br>
Under the tab <code>Your requests</code> in the main menu, you can monitor the status of your data requests.</div>
Expand Down Expand Up @@ -636,9 +636,6 @@ <h3>Further resources<a class="headerlink" href="#further-resources" title="Link
<h2>Example data request<a class="headerlink" href="#example-data-request" title="Link to this heading">#</a></h2>
<section id="example-era5-land-hourly-data-from-1950-to-present">
<h3>Example: <strong>ERA5-Land hourly data from 1950 to present</strong><a class="headerlink" href="#example-era5-land-hourly-data-from-1950-to-present" title="Link to this heading">#</a></h3>
<blockquote>
<div><p>Data used in <a class="reference internal" href="#./113_c3s_climate_indices.ipynb"><span class="xref myst">113_c3s_climate_indices</span></a></p>
</div></blockquote>
<p>CDS API name: <code class="docutils literal notranslate"><span class="pre">reanalysis-era5-land</span></code></p>
<blockquote>
<div><ul class="simple">
Expand Down
2 changes: 1 addition & 1 deletion ci-windchill.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=a3416100" />
<link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-thebe.css?v=4fa983c6" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />

Expand Down
7 changes: 3 additions & 4 deletions ecv-notebooks/erb-outgoing-longwave-radiation.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<link rel="stylesheet" type="text/css" href="../_static/styles/sphinx-book-theme.css?v=a3416100" />
<link rel="stylesheet" type="text/css" href="../_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-thebe.css?v=4fa983c6" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />

Expand Down Expand Up @@ -777,7 +777,7 @@ <h4>Plot data<a class="headerlink" href="#plot-data" title="Link to this heading
December 2018. The maximum values of the OLR are found in the tropics and it decreases toward the
poles. The relative minimum near the equator, in yellow colour, corresponds to the ITCZ and the
convection areas, where persistent and relatively high cloud cover reduces the LW radiation at the
TOA. Antarctica is cooler than the corresponding northern latitudes (<a class="reference internal" href="#harrison"><span class="xref myst">Harrison et al.</span></a>).</p>
TOA. Antarctica is cooler than the corresponding northern latitudes (Harrison et al.).</p>
</section>
</section>
<section id="use-case-2-global-time-series-of-the-olr">
Expand Down Expand Up @@ -912,7 +912,7 @@ <h3><strong>Use case 3</strong>: OLR evolution in the Arctic<a class="headerlink
<p><strong>Figure 3</strong>, shows the evolution of the OLR in the Arctic region [70°N-90°N] for the period 1979-2019
also using a yearly rolling mean. From the image, we can infer an increase in the OLR in the Arctic
region with time. This increase is strongly marked as from 1998 and in line with the increase of
temperature in the Arctic (<a class="reference internal" href="#hansen"><span class="xref myst">Hansen et al, 2010</span></a>), while the relative stability of the first part of the time
temperature in the Arctic (Hansen et al, 2010), while the relative stability of the first part of the time
series is more difficult to interpret due to the major volcanic eruptions in this period.</p>
</section>
</section>
Expand All @@ -927,7 +927,6 @@ <h2>Get more information about Earth Radiation Budget:<a class="headerlink" href
<h2>References<a class="headerlink" href="#references" title="Link to this heading">#</a></h2>
<p>Hansen, J., Ruedy, R., Sato, M., &amp; Lo, K., (2010). <em>Global surface temperature change</em>. Reviews of Geophysics, 48(4).</p>
<p>Harrison, E.F., Gurney, R. J., Foster, J. L., Gurney, R. J., &amp; Parkinson, C. L. (1993). <em>Atlas of satellite observations related to global change</em>. Chapter: Radiation Budget at the top of the atmosphere. Cambridge University Press.</p>
<p><a class="reference internal" href="#page-top"><span class="xref myst">Back to top the Page</span></a></p>
</section>
</section>

Expand Down
4 changes: 2 additions & 2 deletions ecv-notebooks/srb-climatology-and-anomaly.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<link rel="stylesheet" type="text/css" href="../_static/styles/sphinx-book-theme.css?v=a3416100" />
<link rel="stylesheet" type="text/css" href="../_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-thebe.css?v=4fa983c6" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />

Expand Down Expand Up @@ -2241,7 +2241,7 @@ <h3>Plot of the temporal average of SIS<a class="headerlink" href="#plot-of-the-
</section>
<section id="use-case-2-relative-anomaly-hot-summer-of-the-year-2003-in-europe">
<h2>Use case 2: Relative Anomaly. Hot summer of the year 2003 in Europe<a class="headerlink" href="#use-case-2-relative-anomaly-hot-summer-of-the-year-2003-in-europe" title="Link to this heading">#</a></h2>
<p>Please note that you need to open the dataset to be able to execute this usecase, as described in the previous section <a class="reference internal" href="#load"><span class="xref myst">“Load dataset”</span></a>.</p>
<p>Please note that you need to open the dataset to be able to execute this usecase, as described in the previous load data section.</p>
<p>The spatial resolution of the CLARA-A3 radiation dataset is 0.25ºx0.25º that is roughly equal to 25x25 km. With this resolution, it is possible to conduct a regional analysis using the CLARA-A3 radiation datasets. Furthermore, we can use the CLARA-A3 radiation datasets to investigate recent meteorological events. This could be a research project for a student or provide complementary information on a special event, e.g., the analysis of recent heat waves. In recent years, a high number of heat waves appeared in Europe. Particularly interesting is the summer 2003.</p>
<p>Firstly, we will select the data for year 2003 using <code class="docutils literal notranslate"><span class="pre">sel</span></code> argument.</p>
<p>Then, we split the SRB data according to the seasons by using the <code class="docutils literal notranslate"><span class="pre">groupby()</span></code> method, with <code class="docutils literal notranslate"><span class="pre">'time.season'</span></code> as an argument, and then averaged over the years.
Expand Down
2 changes: 1 addition & 1 deletion ecv-notebooks/total-column-water-vapour-combi.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<link rel="stylesheet" type="text/css" href="../_static/styles/sphinx-book-theme.css?v=a3416100" />
<link rel="stylesheet" type="text/css" href="../_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-thebe.css?v=4fa983c6" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />

Expand Down
2 changes: 1 addition & 1 deletion ecv-notebooks/total-ozone-columns.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
<link rel="stylesheet" type="text/css" href="../_static/styles/sphinx-book-theme.css?v=a3416100" />
<link rel="stylesheet" type="text/css" href="../_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-thebe.css?v=4fa983c6" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />

Expand Down
2 changes: 1 addition & 1 deletion genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<link rel="stylesheet" type="text/css" href="_static/styles/sphinx-book-theme.css?v=a3416100" />
<link rel="stylesheet" type="text/css" href="_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css?v=be8a1c11" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-thebe.css?v=4fa983c6" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />

Expand Down
Loading

0 comments on commit ffb984f

Please sign in to comment.