Package: pyfao56
pyfao56A Python implementation of the FAO-56 dual crop coefficient approach for crop water use estimation and irrigation schedulingThe pyfao56 Python package facilitates FAO-56 computations of daily soil water balance using the dual crop coefficient method to estimate crop evapotranspiration (ET).The FAO-56 method is described in the following documentation:Allen, R. G., Pereira, L. S., Raes, D., Smith, M., 1998.  FAO Irrigation and Drainage Paper No. 56. Crop Evapotranspiration: Guidelines for Computing Crop Water Requirements. Food and Agriculture Organization of the United Nations, Rome Italy.Reference ET is computed using the ASCE Standardized Reference ET Equation, which is described in the following documentation:ASCE Task Committee on Standardization of Reference Evapotranspiration (Walter, I. A., Allen, R. G., Elliott, R., Itenfisu, D., Brown, P., Jensen, M. E.,Mecham, B., Howell, T. A., Snyder, R., Eching, S., Spofford, T., Hattendorf, M., Martin, D., Cuenca, R. H., Wright, J. L.), 2005. The ASCE Standardized Reference Evapotranspiration Equation. American Society of Civil Engineers, Reston, VA.Source CodeThe main pyfao56 package contains the following modules:irrigation.py - I/O tools to define irrigation management schedulesmodel.py - Equations for daily soil water balance computationsparameters.py - I/O tools for required input parametersrefet.py - Equations for computing ASCE Standardized Reference ETsoil_profile.py - I/O tools to define stratified soil layer propertiesupdate.py - I/O tools and methods for state variable updatingweather.py - I/O tools for required weather informationThe source code is availablehere. It uses a basic object-oriented design with separate classes to make FAO-56 calculations and to manage parameter, weather, irrigation management, and soil profile data.Pandasdata frames are used for data storage and management. Further documentation of the class structure is contained in the source files.The pyfao56 package contains a new subpackage calledtools, which has several modules to facilitate model use as follows:forecast.py - Obtain a seven-day weather forecast from the National Digital Forecast Database (NDFD)soil_water.py - I/O tools for managing measured volumetric soil water content data and computing root zone soil water metrics from those measurementsvisualization.py - Develop plots to visualize measured and simulated data for root zone soil water depletion and evapotranspirationstatistics.py - Compute 15 goodness-of-fit statistics between measured and simulated dataThe pyfao56 package also contains a subpackage calledcustom. Here, users can add customized scripts to improve their personal pyfao56 workflows. For example, thecustomsubpackage contains modules for development of customized weather files using data from the Arizona Meteorological Network (AZMET) station at Maricopa, Arizona and from the National Digital Forecast Database (NDFD). These modules were developed to facilitate irrigation management for field studies conducted at the Maricopa Agricultural Center. Users can follow this example to create customized weather tools for other weather data sources. Additionally, thecustomsubpackage contains a module for customizing the creation of soil files using ordered lists of soil water holding limits and initial soil water content data.Installpip install pyfao56QuickstartImport the packageimport pyfao56 as faoSpecify the model parametersInstantiate a Parameters class:par = fao.Parameters()To print parameter values:print(par)To adjust parameter values:par.Kcbmid = 1.225To load values from a file:par.loadfile('myfilename.par')To write values to a file:par.savefile('myfilename.par')An example of the parameter file format ishere.Specify the weather informationInstantiate a Weather data class:wth = fao.Weather()To print weather data:print(wth)To load data from a file:wth.loadfile('myfilename.wth')To write data to a file:wth.savefile('myfilename.wth')To compute daily reference ET for yyyy-ddd (4-digit year and day of year):refet = wth.compute_etref('2021-150')An example of the weather file format ishere.Users can customize loading of weather data with wth.customload(). The azmet_maricopa.py module in thecustomsubpackage provides an example for developing a custom weather data class that inherits from Weather and overrides its customload() function.Specify the irrigation management informationInstantiate an Irrigation data class:irr = fao.Irrigation()To print irrigation data:print(irr)To load data from a file:irr.loadfile('myfilename.irr')To write data to a file:irr.savefile('myfilename.irr')To add an irrigation event (provide yyyy, ddd, depth in mm, and fw):irr.addevent(2019, 249, 28.3, 1.00)An example of the irrigation file format ishere.Run the daily soil water balance modelInstantiate a Model class (provide starting yyyy-ddd, ending yyyy-ddd, and classes for Parameters, Weather, and Irrigation):mdl = fao.Model('2013-113','2013-312', par, wth, irr)To run the model:mdl.run()To print the output:print(mdl)To save the output to file:mdl.savefile('myoutputfile.out')An example of the model output file ishere.Specify a layered soil profile (optional)Instantiate a SoilProfile class:sol = fao.SoilProfile()To load data from a file:sol.loadfile('myfilename.sol')To write data to a file:sol.savefile('myfilename.sol')Instantiate a Model class with stratified soil layer data (provide starting yyyy-ddd, ending yyyy-ddd, and classes for Parameters, Weather, Irrigation, and SoilProfile):mdl = fao.Model('2019-108','2019-274', par, wth, irr, sol=sol)To run the model:mdl.run()An example of the soil file format ishere.Users can customize loading of soil profile data with sol.customload(). The example_soil.py module in the custom subpackage provides an example for developing a custom soil data class that inherits from SoilProfile and overrides its customload() function.Update basal crop coefficients (Kcb), crop height (h), or crop cover (fc) (optional)Instantiate an Update class:upd = fao.Update()To load data from a file:upd.loadfile('myfilename.upd')To write data to a file:upd.savefile('myfilename.upd')Instantiate a model class with updating (provide starting yyyy-ddd, ending yyyy-ddd, and classes for Parameters, Weather, Irrigation, and Updates):mdl = fao.Model('2019-108','2019-274', par, wth, irr, upd=upd)To run the model:mdl.run()An example of the update file format ishere.Further examplesFurther example scripts for setting up and running the model arehere.test1- The cottondry2013.py  and cottonwet2013.py modules contain code to setup and run pyfao56 for the water-limited and well-watered treatments for a 2013 cotton field study at Maricopa, Arizona.test2- The refet_testA.py module contains a function to compare the short crop reference evapotranspiration (ETo) calculation from the pyfao56 refet.py module with ETo reported by theAZMETstation at Maricopa, Arizona for 2003 through 2020. The refet_testB.py module contains a function to compare the daily short crop reference evapotranspiration (ETo) and daily tall crop reference evapotranspiration (ETr) calculations from the pyfao56 refet.py module with ETo and ETr computed byRef-ET softwarebased on weather data from theAZMETstation at Maricopa, Arizona for 2003 through 2020. The refet_testC.py module contains a function to compare the hourly ETo and hourly ETr from the pyfao56 refet.py module with ETo and ETr computed byRef-ET softwarebased on weather data from theAZMETstation at Maricopa, Arizona for 2003 through 2020.test3- The updateKcb.py module contains a function to setup and run pyfao56 with basal crop coefficient (Kcb) updates for Zone 12-11 in a 2019 cotton field study at Maricopa, Arizona. The Kcb was estimated from fractional cover measurements based on weekly imagery from a small unoccupied aircraft system (sUAS).test4- The cotton2018.py module contains code to setup and run pyfao56 for water-limited and well-watered treatments for a 2018 cotton field study at Maricopa, Arizona.test5- The cornE12FF2022.py module contains code to setup and run several pyfao56 scenarios (including instances that use the SoilProfile class, the Update class, and both together) for a full-irrigation treatment in a 2022 maize study at Greeley, Colorado.test6- The cotton2022.py module contains code to setup and run pyfao56 for a full-irrigation treatment in a 2022 cotton study at Maricopa, Arizona and to demonstrate the SoilWaterSeries class for computing root zone soil water depletion from  measured soil water content data. The Visualization and Statistics classes are also demonstrated.test7- The cornE42FF2023.py module contains code to setup and run pyfao56 for a full-irrigation treatment in a 2023 maize study at Greeley, Colorado and to demonstrate the Visualization class for visualizing root zone soil water depletion and evapotranspiration time series. The SoilWaterSeries and Statistics classes are also demonstrated.Detailed Startup InformationCore FunctionalityThe core pyfao56 model is designed to follow theFAO-56methodology in the strictest and purest sense. To implement the model, users must first populate two pyfao56 classes with appropriate data: Parameters and Weather. Together, these two classes represent the minimum data inputs that users must provide to conduct a simulation. Irrigation data is also often provided via the Irrigation class, although with version 1.2, irrigation data is not strictly required, and the model will run without it.After the input classes are created and populated, users must then instantiate a Model class by providing the simulation starting date ('yyyy-ddd'), simulation ending date ('yyyy-ddd'), and the instances of the Parameters, Weather, and other optional classes. Users can then run the daily soil water balance model by calling the "run()" method of the Model class.Each pyfao56 simulation is intended to model a single realization of the crop system (i.e., a single treatment, plot, sub-plot, or other homogenous area). Users can iterate simulations among different model realizations by instantiating multiple pyfao56 classes of a particular type (i.e., Parameters, Irrigation, SoilProfile, Model, etc.) and conducting iterative simulations with different input class combinations. Thetest scriptsprovide simple examples of this, while more complex applications are possible.Optional FunctionalityThe pyfao56 package also provides optional functionality that is intended to enhance the implementation of FAO-56 methodology. While the following enhancements may be beneficial for some users, their methodologies are not specifically described in FAO-56.SoilProfile ClassThe SoilProfile class enables input of stratified soil layer information to the model. If available, layered soil profile data should improve the estimates of total available water (TAW) and soil water depletion (Dr) in pyfao56. When including a SoilProfile class in the simulation, the model ignores the thetaFC, thetaWP, and theta0 inputs provided in the Parameters class. Because standard FAO-56 methodology considers only a single, homogenous soil layer, the SoilProfile class can enhance the representation of the soil profile when layered soil profile information is available.Update ClassThe Update class enables users to update key state variables during the model simulation. At this time, the following variables can be updated: basal crop coefficients (Kcb), crop height (h), and crop cover (fc). When the pyfao56 Update class is populated and provided as an input to the Model class, pyfao56 overwrites model state variables with the data provided in the Update class.Constant Depletion FractionThe pyfao56 Model class provides an argument to optionally set the TAW depletion fraction (p) to a constant value. FAO-56 specifies a methodology for varying the depletion fraction based on daily crop evapotranspiration (ETc) (seeFAO-56 page 162 and Table 22). However, FAO-56 also discusses using constant values for depletion fraction (seeFAO-56 page 162andAnnex 8). Annex 8 of FAO-56 suggests setting a constant depletion fraction equal to the management allowed depletion (MAD). Using a constant depletion fraction makes readily available water (RAW) vary only with rooting depth (Zr). Users can run the model with a constant depletion fraction by issuingcons_p=Trueat Model instantiation:mdl = fao.Model('2019-108', '2019-274', par, wth, irr, cons_p=True). By default, the model is instantiated withcons_p=False, which leads to depletion fraction adjustments with ETc.Forecast ClassThe Forecast class is used to retrieve seven-day weather forecasts from the National Digital Forecast Database (NDFD). It uses the REST approach, which was more robust than the SOAP method, in terms of server responsiveness. Data is retrieved for computation of ASCE Standardized Reference Evapotranspiration, including wind speed (m/s) and minimum, maximum, and dew point air temperatures (degrees C). Solar radiation forecasts are not directly provided by NDFD, but NDFD does provide cloud cover forecasts. By providing the optional "elevation" parameter, users can obtain solar radiation forecasts computed by multiplication of cloud cover and clear-sky solar radiation. (However, these soil radiation forecasts were found unreliable at Maricopa, Arizona.) Liquid precipitation forecasts (mm) are also obtained. The NDFD provides wind speed forecasts at 10 m height. The Forecast class contains methods to convert the 10 m wind speeds to the anemometer height of the local weather station. Wind speeds from different sources should be represented at matching heights.SoilWaterSeries ClassThe SoilWaterSeries class provides I/O tools for processing measured volumetric soil water content (SWC, cm3/cm3) data in the pyfao56 environment. The SoilWaterSeries class manages SWC data collected at one location over time (e.g., at one access tube over a growing season). A subclass called SoilWaterProfile handles data storage and computations for one soil water profile measurement event (i.e., measurements of the soil water profile on a single date). The SoilWaterProfile class computes root zone soil water metrics, especially the root zone soil water depletion (SWD, mm), given estimates of root depth.Visualization ClassThe Visualization class provides tools for visualizing pyfao56 Model output with measured soil water data represented in the SoilWaterSeries class. The methods use Python's matplotlib library to format time series plots of soil water depletion, evapotranspiration, and crop coefficient data.Statistics ClassThe Statistics class provides computations of 15 goodness-of-fit statistics when provided arrays of simulated and measured data. Computed statistics include bias, relative bias, percent bias, maximum error, mean error, mean absolute error, sum of squared error, Pearson's correlation coefficient, coefficient of determination, root mean squared error, relative root mean squared error, percent root mean squared error, coefficient of residual mass, the Nash & Sutcliffe (1970) model efficiency, and the Willmott (1981) index of agreement.Further informationThe pyfao56 package is further described in the following articles:Thorp, K. R., Brekel, J., DeJonge, K. C., 2023. Version 1.2.0 - pyfao56: FAO-56 evapotranspiration in Python. SoftwareX 24, 101518.doi.10.1016/j.softx.2023.101518.Brekel, J., Thorp, K. R., DeJonge, K. C., Trout, T. J., 2023. Version 1.1.0 - pyfao56: FAO-56 evapotranspiration in Python. SoftwareX 22, 101336.doi.10.1016/j.softx.2023.101336.Thorp, K. R., 2022. pyfao56: FAO-56 evapotranspiration in Python. SoftwareX 19, 101208.doi:10.1016/softx.2022.101208.Also, the pyfao56 package was used to conduct the following research:Thorp, K. R., 2023. Combining soil water content data with computer simulation models for improved irrigation scheduling. Journal of the ASABE. In press. Accepted 8/14/2023.Thorp, K. R., Calleja, S., Pauli, D., Thompson, A. L., Elshikha, D. E., 2022. Agronomic outcomes of precision irrigation technologies with varying complexity. Journal of the ASABE. 65(1):135-150.doi:10.13031/ja.14950Thorp, K. R., Thompson, A. L., Harders, S. J., French, A. N., Ward, R. W., 2018. High-throughput phenotyping of crop water use efficiency via multispectral drone imagery and a daily soil water balance model. Remote Sensing 10, 1682.doi:10.3390/rs10111682