GithubHelp home page GithubHelp logo

pyet-org / pyet Goto Github PK

View Code? Open in Web Editor NEW
109.0 3.0 29.0 140.99 MB

:sunflower: pyet is a Python package to estimate reference and potential evaporation.

Home Page: https://pyet.readthedocs.io/

License: MIT License

Python 100.00%
hydrological-modelling hydrology water

pyet's Introduction

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)

We support Python >= 3.8.

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.: Technical note: Improved handling of potential evapotranspiration in hydrological studies with PyEt, Hydrol. Earth Syst. Sci. Discuss. [preprint], https://doi.org/10.5194/hess-2022-417, in review, 2023.
@Article{hess-2022-417,
  AUTHOR = {Vremec, M. and Collenteur, R. A. and Birk, S.},
  TITLE = {Technical note: Improved handling of potential evapotranspiration in hydrological studies with \textit{PyEt}},
  JOURNAL = {Hydrology and Earth System Sciences Discussions},
  VOLUME = {2023},
  YEAR = {2023},
  PAGES = {1--23},
  URL = {https://hess.copernicus.org/preprints/hess-2022-417/},
  DOI = {10.5194/hess-2022-417}
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.