Update docs

pyet-org · Mar 15, 2024 · 7407436 · 7407436
1 parent 54f0d20
commit 7407436
Show file tree

Hide file tree

Showing 2 changed files with 224 additions and 54 deletions.
diff --git a/docs/examples/index.rst b/docs/examples/index.rst
@@ -8,16 +8,36 @@ evaporation.
     :numbered:
     :glob:
 
-    01_example_zamg
-    02_example_zamg_netcdf
-    03_example_knmi
-    04_example_coagmet
-    05_example_calibration
-    06_worked_examples_McMahon_etal_2013
-    07_example_climate_change
-    08_crop_coefficient
-    09_CMIP6_data
-    10_example_paper
+`Estimating PET using pandas.Series`_
+
+`Estimating PET using xarray.DataArray`_
+
+`Benchmarking Makkink`_
+
+`Benchmarking FAO56`_
+
+`Calibration`_
+
+`Examples from McMahon et al., 2013`_
+
+`PET under climate change`_
+
+`Crop coefficient`_
+
+`Estimating PET using CMIP data`_
+
+`Notebook supporting PyEt GMD manuscript`_
+
+.. _Estimating PET using pandas.Series: 01_example_zamg.ipynb
+.. _Estimating PET using xarray.DataArray: 02_example_zamg_netcdf.ipynb
+.. _Benchmarking Makkink: 03_example_knmi.ipynb
+.. _Benchmarking FAO56: 04_example_coagmet.ipynb
+.. _Calibration: 05_example_calibration.ipynb
+.. _Examples from McMahon et al., 2013: 06_worked_examples_McMahon_etal_2013.ipynb
+.. _PET under climate change: 07_example_climate_change.ipynb
+.. _Crop coefficient: 08_crop_coefficient.ipynb
+.. _Estimating PET using CMIP data: 09_CMIP6_data.ipynb
+.. _Notebook supporting PyEt GMD manuscript: 10_example_paper.ipynb
 
 .. tip::
     The latest versions of the Jupyter Notebooks can be found in the

diff --git a/docs/index.rst b/docs/index.rst
@@ -8,7 +8,7 @@ allows users to estimate potential evapotranspiration and calibrate the models w
 .. grid::
 
     .. grid-item-card:: Getting started
-        :link: userguide/index
+        :link: user_guide/index
         :link-type: doc
 
         User guide on the basic concepts of Pastas.
@@ -42,49 +42,199 @@ allows users to estimate potential evapotranspiration and calibrate the models w
 Currently, 18 methods are implemented for calculating daily PET
 -----------------------------
 
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Method name         | pyet function       | T   | RH  | R   | u2  | Lat.| El. | Benchmarked?  |
-+=====================+=====================+=====+=====+=====+=====+=====+=====+===============+
-| Penman              | penman              | ✓ 1 | ✓ 2 | ✓ 3 | ✓   | ✓ 3 | ✓ 4 | ✓           |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Penman-Monteith     | pm                  | ✓ 1 | ✓ 2 | ✓ 3 | ✓   | ✓ 3 | ✓ 4 | ✓           |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| ASCE-PM             | pm_asce             | ✓ 1 | ✓ 2 | ✓ 3 | ✓   | ✓ 3 | ✓ 4 | ✓           |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| FAO-56              | pm_fao56            | ✓ 1 | ✓ 2 | ✓ 3 | ✓   | ✓ 3 | ✓ 4 | ✓           |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Priestley-Taylor    | priestley_taylor    | ✓   | ✓ 5 | ✓ 5 | -   | ✓ 5 | ✓ 4 | ✓           |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Kimberly-Penman     | kimberly_penman     | ✓ 1 | ✓ 2 | ✓ 3 | ✓   | ✓ 3 | ✓ 4 | -           |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Thom-Oliver         | thom_oliver         | ✓ 1 | ✓ 2 | ✓ 3 | ✓   | ✓ 3 | ✓ 4 | -           |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Blaney-Criddle      | blaney_criddle      | ✓   | - 6 | - 6 | - 6 | ✓   | -   | ✓            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Hamon               | hamon               | ✓   | -   | -   | -   | ✓   | -   | ✓            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Romanenko           | romanenko           | ✓   | ✓   | -   | -   | -   | -   | ✓            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Linacre             | linacre             | ✓ 7 | -   | -   | -   | -   | ✓   | ✓            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Haude               | haude               | ✓   | ✓ 8 | -   | -   | -   | -   | ✓            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Turc                | turc                | ✓   | ✓   | ✓   | -   | -   | -   | ✓            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Jensen-Haise        | jensen_haise        | ✓   | -   | ✓ 9 | -   | ✓ 9 | -   | ✓            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| McGuinness-Bordne   | mcguinness_bordne   | ✓   | -   | -   | -   | ✓   | -   | ✓            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Hargreaves          | hargreaves          | ✓ 10| -   | -   | -   | ✓   | -   | ✓            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| FAO-24 radiation    | fao_24              | ✓   | ✓   | ✓   | ✓   | -   | ✓ 4 | -           |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Abtew               | abtew               | ✓   | -   | ✓   | -   | -   | -   | ✓            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Makkink             | makkink             | ✓   | -   | ✓   | -   | -   | ✓ 4 | ✓            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
-| Oudin               | oudin               | ✓   | -   | -   | -   | ✓   | -   | -            |
-+---------------------+---------------------+-----+-----+-----+-----+-----+-----+---------------+
+.. list-table:: PET Calculation Methods
+   :widths: 15 15 5 5 5 5 5 5 10
+   :header-rows: 1
+
+   * - Method name
+     - pyet function
+     - T
+     - RH
+     - R
+     - u2
+     - Lat.
+     - El.
+     - Benchmarked?
+   * - Penman
+     - penman
+     - ✓ [1]
+     - ✓ [2]
+     - ✓ [3]
+     - ✓
+     - ✓ [3]
+     - ✓ [4]
+     - ✓
+   * - Penman-Monteith
+     - pm
+     - ✓ [1]
+     - ✓ [2]
+     - ✓ [3]
+     - ✓
+     - ✓ [3]
+     - ✓ [4]
+     - ✓
+   * - ASCE-PM
+     - pm_asce
+     - ✓ [1]
+     - ✓ [2]
+     - ✓ [3]
+     - ✓
+     - ✓ [3]
+     - ✓ [4]
+     - ✓
+   * - FAO-56
+     - pm_fao56
+     - ✓ [1]
+     - ✓ [2]
+     - ✓ [3]
+     - ✓
+     - ✓ [3]
+     - ✓ [4]
+     - ✓
+   * - Priestley-Taylor
+     - priestley_taylor
+     - ✓
+     - ✓ [5]
+     - ✓ [5]
+     - -
+     - ✓ [5]
+     - ✓ [4]
+     - ✓
+   * - Kimberly-Penman
+     - kimberly_penman
+     - ✓ [1]
+     - ✓ [2]
+     - ✓ [3]
+     - ✓
+     - ✓ [3]
+     - ✓ [4]
+     - -
+   * - Thom-Oliver
+     - thom_oliver
+     - ✓ [1]
+     - ✓ [2]
+     - ✓ [3]
+     - ✓
+     - ✓ [3]
+     - ✓ [4]
+     - -
+   * - Blaney-Criddle
+     - blaney_criddle
+     - ✓
+     - - [6]
+     - - [6]
+     - - [6]
+     - ✓
+     - -
+     - ✓
+   * - Hamon
+     - hamon
+     - ✓
+     - -
+     - -
+     - -
+     - ✓
+     - -
+     - ✓
+   * - Romanenko
+     - romanenko
+     - ✓
+     - ✓
+     - -
+     - -
+     - -
+     - -
+     - ✓
+   * - Linacre
+     - linacre
+     - ✓ [7]
+     - -
+     - -
+     - -
+     - -
+     - ✓
+     - ✓
+   * - Haude
+     - haude
+     - ✓
+     - ✓ [8]
+     - -
+     - -
+     - -
+     - -
+     - ✓
+   * - Turc
+     - turc
+     - ✓
+     - ✓
+     - ✓
+     - -
+     - -
+     - -
+     - ✓
+   * - Jensen-Haise
+     - jensen_haise
+     - ✓
+     - -
+     - ✓ [9]
+     - -
+     - ✓ [9]
+     - -
+     - ✓
+   * - McGuinness-Bordne
+     - mcguinness_bordne
+     - ✓
+     - -
+     - -
+     - -
+     - ✓
+     - -
+     - ✓
+   * - Hargreaves
+     - hargreaves
+     - ✓ [10]
+     - -
+     - -
+     - -
+     - ✓
+     - -
+     - ✓
+   * - FAO-24 radiation
+     - fao_24
+     - ✓
+     - ✓
+     - ✓
+     - ✓
+     - -
+     - ✓ [4]
+     - -
+   * - Abtew
+     - abtew
+     - ✓
+     - -
+     - ✓
+     - -
+     - -
+     - -
+     - ✓
+   * - Makkink
+     - makkink
+     - ✓
+     - -
+     - ✓
+     - -
+     - -
+     - ✓ [4]
+     - ✓
+   * - Oudin
+     - oudin
+     - ✓
+     - -
+     - -
+     - -
+     - ✓
+     - -
+     - -
 
 .. rubric:: Footnotes