Merge pull request #6 from phydrus/dev

Dev update
pyet-org · Apr 27, 2021 · a843799 · a843799
2 parents 3b62520 + f7ae34f
commit a843799
Show file tree

Hide file tree

Showing 28 changed files with 1,962 additions and 1,178 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+<img src=https://raw.githubusercontent.com/phydrus/pyet/d7fdd87719588c00326e692f3b1a47b32161e533/docs/_static/logo.png width=120, align=left>
+
 # pyet: Estimation of Potential Evaporation
 
 <a href="http://www.gnu.org/licenses/gpl-3.0.txt"><img src=https://img.shields.io/github/license/phydrus/pyet> </a>
@@ -8,7 +10,7 @@
 
 
 pyet is an open source python package for calculating reference and potential 
-evaporation (PET). Currently eighteen methods for calculating PET are 
+evaporation (PE). Currently eighteen methods for calculating PE are 
 implemented:
 
 | Classification | Common method name        | Data needed | pyet Method        | Reference                   |
@@ -43,7 +45,7 @@ software. Documentation is hosted on [ReadTheDocs](https://pyet.readthedocs.io).
 After defining the input data, evaporation is estimated using only one 
 line of python code:
 
-`>>> pyet.pm_fao56(wind, elevation, latitude, solar=solar, tmax=tmax, tmin=tmin, rh=rh)`
+`>>> pyet.pm_fao56(tmean, wind, rn=rn, tmax=tmax, tmin=tmin, rh=rh, elevation=elevation)`
 
 ## Bug reports and Questions
 

diff --git a/docs/_static/logo.png b/docs/_static/logo.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -70,7 +70,8 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ['_static']
+html_logo = "_static/logo.png"
 
 autosummary_generate = True
 numpydoc_show_class_members = False
diff --git a/docs/examples/01_example_knmi.ipynb.nblink b/docs/examples/01_example_knmi.ipynb.nblink
@@ -0,0 +1,3 @@
+{
+    "path": "../../examples/01_example_knmi.ipynb"
+}
diff --git a/docs/examples/02_example_coagmet.ipynb.nblink b/docs/examples/02_example_coagmet.ipynb.nblink
@@ -0,0 +1,3 @@
+{
+    "path": "../../examples/02_example_coagmet.ipynb"
+}
diff --git a/docs/examples/03_example_calibration.ipynb.nblink b/docs/examples/03_example_calibration.ipynb.nblink
@@ -0,0 +1,3 @@
+{
+    "path": "../../examples/03_example_calibration.ipynb"
+}
diff --git a/docs/examples/index.rst b/docs/examples/index.rst
@@ -0,0 +1,20 @@
+Example Gallery
+===============
+Below you can find examples of how pyet models are used for estimating (potential) 
+evaporation. 
+
+.. toctree::
+    :maxdepth: 2
+    :numbered:
+    :hidden:
+
+.. tip::
+    The latest versions of the Jupyter Notebooks can be found in the
+    examples folder on GitHub!
+
+.. nbgallery::
+    :caption: Click on one of the examples below:
+    :name: rst-gallery
+    :glob:
+
+    ./*
diff --git a/docs/getting_started/index.rst b/docs/getting_started/index.rst
@@ -1,7 +1,7 @@
 Getting started with pyet
 ============================
 In this section you can find guidance on how to get started with pyet
-Before being able to run a Phydrus model from Python Console you need to 
+Before being able to run a pyet model from Python Console you need to
 install the pyet package
 
 .. toctree::

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,14 +1,15 @@
 *pyet* - Estimation of Potential Evaporation
 ===============================
 
-pyet is an open source Python package for estimating reference and potential evaporation (PET) using time series data. This enables the user to estimate evaporation and calibrate the models with just a few lines of python code.
+pyet is an open source Python package for estimating reference and potential evaporation (PE) using time series data. This enables the user to estimate evaporation and calibrate the models with just a few lines of python code.
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    Getting started <getting_started/index>
    Methods <methods/index>
+   Examples <examples/index>
    API-docs <api/index>
    References <references>
 

diff --git a/docs/methods/combination.rst b/docs/methods/combination.rst
@@ -6,28 +6,28 @@ Penman (1948)
 
 .. math::
 
-      PET = \frac{\Delta (R_n - G) + \gamma 2.6 (1 + 0.536 u_2)(e_s-e_a)}{\lambda (\Delta +\gamma)}
+      PE = \frac{\Delta (R_n - G) + \gamma 2.6 (1 + 0.536 u_2)(e_s-e_a)}{\lambda (\Delta +\gamma)}
 
 FAO-56 Penman-Monteith (Allen, 1998)
 ------------------------------------
 
 .. math::
 
-    PET = \frac{0.408 \Delta (R_n - G)+\gamma \frac{900}{T+273}(e_s-e_a) u_2}{\Delta+\gamma(1+0.34 u_2)}
+    PE = \frac{0.408 \Delta (R_n - G)+\gamma \frac{900}{T+273}(e_s-e_a) u_2}{\Delta+\gamma(1+0.34 u_2)}
 
 Penman-Monteith (Monteith, 1965)
 --------------------------------
 
 .. math::
 
-    PET = \frac{\Delta (R_n-G)+ \rho_a c_p 86400 \frac{e_s-e_a}{r_a}}{\lambda(\Delta +\gamma(1+\frac{r_s}{r_a}))}
+    PE = \frac{\Delta (R_n-G)+ \rho_a c_p 86400 \frac{e_s-e_a}{r_a}}{\lambda(\Delta +\gamma(1+\frac{r_s}{r_a}))}
 
 Kimberly-Penman (Wright, 1982)
 ------------------------------
 
 .. math::
 
-    PET = \frac{\Delta (R_n-G)+ \gamma (e_s-e_a) w}{\lambda(\Delta+\gamma)}
+    PE = \frac{\Delta (R_n-G)+ \gamma (e_s-e_a) w}{\lambda(\Delta+\gamma)}
 
 .. math::
 
@@ -39,14 +39,14 @@ Priestley and Taylor (1972)
 
 .. math::
 
-    PET = \frac{\alpha_{PT} \Delta (R_n-G)}{\lambda(\Delta + \gamma)}
+    PE = \frac{\alpha_{PT} \Delta (R_n-G)}{\lambda(\Delta + \gamma)}
 
 Thom and Oliver (1977)
 ----------------------
 
 .. math::
 
-    PET = \frac{\Delta (R_n-G)+ 2.5 \gamma (e_s-e_a) w}{\lambda(\Delta+\gamma(1+\frac{r_s}{r_a}))}
+    PE = \frac{\Delta (R_n-G)+ 2.5 \gamma (e_s-e_a) w}{\lambda(\Delta+\gamma(1+\frac{r_s}{r_a}))}
 
 .. math::
 

diff --git a/docs/methods/radiation.rst b/docs/methods/radiation.rst
@@ -6,45 +6,45 @@ Turc (1961)
 
 .. math::
 
-    PET=k(\frac{T_a}{T_a+15})(R_s/4.184 + 50)*4.184; for RH>50
+    PE=k(\frac{T_a}{T_a+15})(R_s/4.184 + 50)*4.184; for RH>50
 
 .. math::
 
-    PET=k(\frac{T_a}{T_a+15})(R_s/4.184 + 50)(1+\frac{50-RH}{70})*4.184;for RH<50
+    PE=k(\frac{T_a}{T_a+15})(R_s/4.184 + 50)(1+\frac{50-RH}{70})*4.184;for RH<50
 
 
 Jensen and Haise (2005)
 -----------------------
 
 .. math::
 
-    PET = \frac{C_r (T - T_x) R_s}{\lambda}
+    PE = \frac{C_r (T - T_x) R_s}{\lambda}
 
 .. math::
 
-    PET = \frac{R_a (T_a+5)}{\lambda 68}
+    PE = \frac{R_a (T_a+5)}{\lambda 68}
 
 McGuinness and Bordne (1972)
 ----------------------------
 
 .. math::
 
-    PET = \frac{0.0147 R_a (T_a + 5)}{\lambda}
+    PE = \frac{0.0147 R_a (T_a + 5)}{\lambda}
 
 
 Hargreaves (Hargreaves and Samani, 1982; 1985)
 ----------------------------------------------
 
 .. math::
 
-    PET = 0.0023 \frac{R_a (T_a+17.8)\sqrt{(T_{max}-T_{min})}}{\lambda}$
+    PE = 0.0023 \frac{R_a (T_a+17.8)\sqrt{(T_{max}-T_{min})}}{\lambda}$
 
 Doorenbos–Pruitt (FAO-24) (Jensen et al., 1990)
 -----------------------------------------------
 
 .. math::
 
-    PET = \frac{-0.3 \Delta + R_s (1-\alpha) w}{\lambda(\Delta +\gamma)}
+    PE = \frac{-0.3 \Delta + R_s (1-\alpha) w}{\lambda(\Delta +\gamma)}
 
 .. math::
 
@@ -55,21 +55,21 @@ Abtew (1996)
 
 .. math::
 
-    PET = \frac{k R_s}{\lambda}
+    PE = \frac{k R_s}{\lambda}
 
 Makkink (1957)
 --------------
 
 .. math::
 
-    PET = \frac{0.65 \Delta (R_s)}{\lambda(\Delta+\gamma)}
+    PE = \frac{0.65 \Delta (R_s)}{\lambda(\Delta+\gamma)}
 
 Oudin (1961)
 -------------
 
 .. math::
 
-    PET = \frac{R_a (T_a+K_2)}{\lambda K_1}; if T_a+K_2>0
+    PE = \frac{R_a (T_a+K_2)}{\lambda K_1}; if T_a+K_2>0
 
 .. math::
 

diff --git a/docs/methods/temperature.rst b/docs/methods/temperature.rst
@@ -6,28 +6,28 @@ Blaney-Criddle (1950)
 
 .. math::
 
-    PET=kp(0.46 * T_a + 8.13)
+    PE=kp(0.46 * T_a + 8.13)
 
 Hamon (1961)
 ------------
 
 .. math::
 
-    PET = (\frac{DL}{12})^2 exp(\frac{T_a}{16})
+    PE = (\frac{DL}{12})^2 exp(\frac{T_a}{16})
 
 Romanenko (1961)
 ----------------
 
 .. math::
 
-    PET=4.5(1 + (\frac{T_a}{25})^2 (1  \frac{e_a}{e_s})
+    PE=4.5(1 + (\frac{T_a}{25})^2 (1  \frac{e_a}{e_s})
 
 Linacre (1977)
 --------------
 
 .. math::
 
-    PET = \frac{\frac{500 T_m}{(100-A)}+15 (T_a-T_d)}{80-T_a}
+    PE = \frac{\frac{500 T_m}{(100-A)}+15 (T_a-T_d)}{80-T_a}
 
 .. math::
 

diff --git a/docs/methods/units.rst b/docs/methods/units.rst
@@ -8,7 +8,7 @@ Notation and units
    * - .. math:: Variable
      - .. math:: Description
      - .. math:: Units
-   * - .. math:: PET
+   * - .. math:: PE
      - Potential evaporation
      - .. math:: mm d^{-1}
    * - .. math:: \Delta