Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mvremec committed Mar 15, 2024
1 parent 2df23c6 commit 4a5db92
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 244 deletions.
31 changes: 0 additions & 31 deletions docs/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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!
213 changes: 0 additions & 213 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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!
-----------------------------

Expand Down

0 comments on commit 4a5db92

Please sign in to comment.