From 4a5db92c393a2a8232aef2a2e27645a1753016b1 Mon Sep 17 00:00:00 2001 From: MatevzVremec Date: Fri, 15 Mar 2024 09:53:11 +0100 Subject: [PATCH] Update docs --- docs/examples/index.rst | 31 ------ docs/index.rst | 213 ---------------------------------------- 2 files changed, 244 deletions(-) diff --git a/docs/examples/index.rst b/docs/examples/index.rst index f0047f0..88cfd06 100644 --- a/docs/examples/index.rst +++ b/docs/examples/index.rst @@ -19,37 +19,6 @@ evaporation. 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 examples folder on GitHub! diff --git a/docs/index.rst b/docs/index.rst index f13fb56..cde8e29 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -39,219 +39,6 @@ allows users to estimate potential evapotranspiration and calibrate the models w References used in the package. - -Currently, 18 methods are implemented for calculating daily PET ------------------------------ - -.. list-table:: - :widths: 20 20 5 5 5 5 5 5 15 - :header-rows: 1 - - * - Method name - - pyet function - - T - - RH - - R - - u2 - - Lat. - - El. - - Benchmarked? - * - Penman - - penman - - ✓ `a`_ - - ✓ `b,c`_ - - ✓ `d`_ - - ✓ - - ✓ `d`_ - - ✓ `e`_ - - ✓ - * - Penman-Monteith - - pm - - ✓ `a`_ - - ✓ `b,c`_ - - ✓ `d`_ - - ✓ - - ✓ `d`_ - - ✓ `e`_ - - ✓ - * - ASCE-PM - - pm_asce - - ✓ `a`_ - - ✓ `b,c`_ - - ✓ `d`_ - - ✓ - - ✓ `d`_ - - ✓ `e`_ - - ✓ - * - FAO-56 - - pm_fao56 - - ✓ `a`_ - - ✓ `b,c`_ - - ✓ `d`_ - - ✓ - - ✓ `d`_ - - ✓ `e`_ - - ✓ - * - Priestley-Taylor - - priestley_taylor - - ✓ - - ✓ `h`_ - - ✓ `h`_ - - - - - ✓ `h`_ - - ✓ `e`_ - - ✓ - * - Kimberly-Penman - - kimberly_penman - - ✓ `a`_ - - ✓ `b,c`_ - - ✓ `d`_ - - ✓ - - ✓ `d`_ - - ✓ `e`_ - - - - * - Thom-Oliver - - thom_oliver - - ✓ `a`_ - - ✓ `b,c`_ - - ✓ `d`_ - - ✓ - - ✓ `d`_ - - ✓ `e`_ - - - - * - Blaney-Criddle - - blaney_criddle - - ✓ - - - `i`_ - - - `i`_ - - - `i`_ - - ✓ - - - - - ✓ - * - Hamon - - hamon - - ✓ - - - - - - - - - - - ✓ - - - - - ✓ - * - Romanenko - - romanenko - - ✓ - - ✓ - - - - - - - - - - - - - - ✓ - * - Linacre - - linacre - - ✓ `j`_ - - - - - - - - - - - - - - ✓ - - ✓ - * - Haude - - haude - - ✓ - - ✓ `k`_ - - - - - - - - - - - - - - ✓ - * - Turc - - turc - - ✓ - - ✓ - - ✓ - - - - - - - - - - - ✓ - * - Jensen-Haise - - jensen_haise - - ✓ - - - - - ✓ `l`_ - - - - - ✓ `l`_ - - - - - ✓ - * - McGuinness-Bordne - - mcguinness_bordne - - ✓ - - - - - - - - - - - ✓ - - - - - ✓ - * - Hargreaves - - hargreaves - - ✓ `m`_ - - - - - - - - - - - ✓ - - - - - ✓ - * - FAO-24 radiation - - fao_24 - - ✓ - - ✓ - - ✓ - - ✓ - - - - - ✓ `e`_ - - - - * - Abtew - - abtew - - ✓ - - - - - ✓ - - - - - - - - - - - ✓ - * - Makkink - - makkink - - ✓ - - - - - ✓ - - - - - - - - ✓ `e`_ - - ✓ - * - Oudin - - oudin - - ✓ - - - - - - - - - - - ✓ - - - - - - - -.. rubric:: Footnotes - -.. _`a`: T_max and T_min can also be provided. -.. _`b`: RH_max and RH_min can also be provided. -.. _`c`: If actual vapor pressure is provided, RH is not needed. -.. _`d`: Input for radiation can be (1) Net radiation, (2) solar radiation, or (3) sunshine hours. If (1), then latitude is not needed. If (1, 3) then latitude and elevation are needed. -.. _`e`: One must provide either the atmospheric pressure or elevation. -.. _`h`: If net radiation is provided, RH and Lat are not needed. -.. _`i`: If method==2, u2, RH_min, and sunshine hours are required. -.. _`j`: Additional input of Tmax and Tmin, or Tdew. -.. _`k`: Input can be RH or actual vapor pressure. -.. _`l`: If method==1, latitude is needed instead of Rs. -.. _`m`: Tmax and Tmin also needed. - - Using *pyet*? Show your support by citing us! -----------------------------