Skip to main content

pyet - Estimation of Potential Evaporation

Project description

pyet: Estimation of Potential Evapotranspiration

codacy-coverage-reporter Codacy Badge Codacy Badge

pyet is an open source python package for calculating reference and potential Evapotranspiration (PET) for 1D (pandas.Series) and 3D (xarray.DataArrray) data. Currently, eighteen methods for calculating daily PET are implemented:

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 - - - - -

$^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) latitude and elevation is needed. $^e$ One must provide either the atmospheric pressure or elevation. $^f$ The PM method can be used to estimate potential crop evapotranspiration, if leaf area index or crop height data is available. $^g$ The effect of $CO_2$ on stomatal resistance can be included using the formulation of Yang et al. 2019. $^h$ If net radiation is provided, RH and Lat are not needed. $^i$ If method==2, $u_2$, $RH_{min}$ and sunshine hours are required. $^j$ Additional input of $T_{max}$ and $T_{min}$, or $T_{dew}$. $^k$ Input can be $RH$ or actual vapor pressure. $^l$ If method==1, latitude is needed instead of $R_s$. $^m$ $T_{max}$ and $T_{min}$ also needed.

Examples and Documentation

Examples of using pyet can be found in the example folder:

  • Example 1: Estimating PET using pandas.Series

  • Example 2: Estimating PET using xarray.DataArray

  • Example 3: Benchmarking Makkink against KNMI data

  • Example 4: Benchmarking FAO56 against CoAgMET data

  • Example 5: Calibrating the Romanenko and Abtew method against the PM-FAO56

  • Example 6: Worked examples for estimating meteorological variables and potential evapotranspiration after McMahon et al., 2013

  • Example 7: Example for estimating potential evapotranspiration under warming and elevated $CO_2$ concentrations following Yang et al., (2019)

  • Example 8: Determining the crop coefficient function with Python

  • Example 9: Estimating PET using CMIP data

  • Example 10: Notebook supporting PyEt manuscript

Documentation is hosted on ReadTheDocs.

After defining the input data, evapotranspiration is estimated using only one line of python code:

>>> pyet.pm_fao56(tmean, wind, rn=rn, tmax=tmax, tmin=tmin, rh=rh, elevation=elevation)

Benchmarking

Most of the methods implemented in pyet are benchmarked against literature values from the FAO Irrigation and drainage paper 56, McMahon et al., 2013 (supplementary) and Schrödter, 1985. In addition, two comparative analysis between daily PE estimated with pyet and other organizations is made:

  • pyet.pm_fao56 against daily PET estimated with ASCE Penman-Monteith from CoAgMET ( Colorado State University),

  • pyet.makkink against daily PET estimated with Makkink from The Royal Netherlands Meteorological Institute (KNMI).

Data dimensions

As of version v1.2., pyet is compatible with both Pandas.Series and xarray.DataArray, which means you can now estimate potential evapotranspiration for both point and gridded data.

Bug reports and Questions

pyet is in active development, and bug reports are welcome as GitHub Issues. General questions or discussions are possible through GitHub Discussions.

Installation

The pyet package is available from the Pypi package index and can be installed as follows::

>>> pip install pyet

To install in developer mode, use the following syntax:

>>> pip install -e .

Citing

If you use pyet in one of your studies, please cite the pyet EGU abstract:

  • Vremec, M., Collenteur, R. A., and Birk, S.: PyEt v1.3.1: a Python package for the estimation of potential evapotranspiration, Geosci. Model Dev., 17, 7083–7103, https://doi.org/10.5194/gmd-17-7083-2024, 2024.
@Article{gmd-17-7083-2024,
AUTHOR = {Vremec, M. and Collenteur, R. A. and Birk, S.},
TITLE = {\textit{PyEt} v1.3.1: a Python package for the estimation of potential evapotranspiration},
JOURNAL = {Geoscientific Model Development},
VOLUME = {17},
YEAR = {2024},
NUMBER = {18},
PAGES = {7083--7103},
URL = {https://gmd.copernicus.org/articles/17/7083/2024/},
DOI = {10.5194/gmd-17-7083-2024}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyet-1.4.0.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyet-1.4.0-py3-none-any.whl (24.1 kB view details)

Uploaded Python 3

File details

Details for the file pyet-1.4.0.tar.gz.

File metadata

  • Download URL: pyet-1.4.0.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for pyet-1.4.0.tar.gz
Algorithm Hash digest
SHA256 0386fea15ae382d506b2178dc4755661bd06a23e72c84b6b9edae8f5f12d9581
MD5 a276785e57a0adea8f9b89130fe79255
BLAKE2b-256 cf428d494a63d807295d46d0af6272f285dd72093629c36ba68af098d04639f0

See more details on using hashes here.

File details

Details for the file pyet-1.4.0-py3-none-any.whl.

File metadata

  • Download URL: pyet-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 24.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for pyet-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 db585b9416b72cb0c870af0ae455a5308fa9e09337f892d7d9023bce95655bee
MD5 30cd8d9bc9dc6fa0b9c120de3119d600
BLAKE2b-256 5b4390ac5c179d35046a5f22f48ffea8ca17f2f99c5ea6988373733eed665e52

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page