Skip to content

Commit

Permalink
DOC: fix build
Browse files Browse the repository at this point in the history
  • Loading branch information
Abel Aoun committed Jan 22, 2024
1 parent 77e1d90 commit e76c796
Show file tree
Hide file tree
Showing 5 changed files with 1,773 additions and 18 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ __pycache__/
*.so

# generated files
*.zarr
*.zip
*.nc*
out_icclim/

Expand Down Expand Up @@ -80,7 +82,6 @@ target/

dask-worker-space/

*.zarr

# notebooks checkpoints
.ipynb_checkpoints
15 changes: 7 additions & 8 deletions doc/source/references/icclim_index_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,20 +47,19 @@ See :py:class:`StandardVariable` for a list of all the aliases of each standardi
So, if a 'mean_temperatures.nc' contains a tas variable and 'precipitations.nc' a pr variable,
the following is sufficient to compute CW.

```py
icclim.cw(in_files=["mean_temperatures.nc", "precipitations.nc"]).compute.CW
```
.. code-block:: python
icclim.cw(in_files=["mean_temperatures.nc", "precipitations.nc"]).compute.CW
In case variables' name cannot be guessed, you can explicitly name the variable
you wish to read from the input file:

```py
.. code-block:: python
icclim.cw(in_files={"customTas": mean_temperatures.nc, "pr": "precipitations.nc"})
icclim.cw(in_files={"customTas": mean_temperatures.nc, "pr": "precipitations.nc"})
# equivalent to
icclim.cw(in_files=["mean_temperatures.nc, "precipitations.nc"], var_name=["custom_tas", "pr"])
```
# equivalent to
icclim.cw(in_files=["mean_temperatures.nc", "precipitations.nc"], var_name=["custom_tas", "pr"])
The order in which variables are passed matters and must follow the ``input_variables`` property defined in the
respective index of :py:class:`EcadIndexRegistry`.
Expand Down
5 changes: 2 additions & 3 deletions doc/source/tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,12 @@ capabilities. To see how icclim can solve specific issues see
:ref:`how_to`.

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Contents:

installation
notebooks/averaged_tas_anomaly
notebooks/averaged_temperature_anomaly
notebooks/deltat_deltap_anomaly
notebooks/deltaT_deltaP_anomaly
notebooks/tg90p_calculate__subset_and_plot
notebooks/userindex_maxtemp_freezing
notebooks/cold_spell_duration
12 changes: 6 additions & 6 deletions doc/source/tutorials/notebooks/averaged_tas_anomaly.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"\n",
"The datasets that are expected for this notebook are tas parameter (needed to calculate the TG indicator) for several climate models, for the historical (1971-2000) and ssp585 (2081-2100) experiments and for one member. Daily data is used. In [C4I](https://www.climate4impact.eu/c4i-frontend/search), you can find all of the data needed in the CMIP6 project, at the **esgf-data3.ceda.ac.uk** and **esgf3.dkrz.de** mirrors.\n",
"\n",
"### Preparation of the needed modules"
"## Preparation of the needed modules"
]
},
{
Expand Down Expand Up @@ -143,7 +143,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Datasets\n",
"### Datasets\n",
"\n",
"The metafile associated with this notebook describes how to download the dataset we use here.\\\n",
"We reccomend to use [aria2](https://github.com/aria2/aria2) to parse the metafile and download the dataset it describes.\\\n",
Expand All @@ -154,7 +154,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Specification of the parameters and period of interest\n",
"## Specification of the parameters and period of interest\n",
"\n",
"The time period of interest as well as the reference period are defined here.\n",
"A list of models is listed here as an example.\n",
Expand Down Expand Up @@ -345,7 +345,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Perform spacial average on all the geographical domain"
"## Perform spacial average on all the geographical domain"
]
},
{
Expand Down Expand Up @@ -425,7 +425,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Plot a multi-model time series for the future time period\n",
"## Plot a multi-model time series for the future time period\n",
"\n",
"Temperature for SSP585 of the period 2080-2100.\n",
"\n",
Expand Down Expand Up @@ -468,7 +468,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"### Plot a time series of the anomaly of temperature\n",
"## Plot a time series of the anomaly of temperature\n",
"Anomaly of temperature for SSP585 of the period 2080-2100 compared to 1971-2000.\n",
"\n",
"The multi-model average is shown in bold black line."
Expand Down
Loading

0 comments on commit e76c796

Please sign in to comment.