AquaCrop Plug-In Program (Version 6.0) FAO 2018 - Reference Manual
AquaCrop Plug-In Program (Version 6.0) FAO 2018 - Reference Manual
Plug-in program
(Version 6.0)
Reference manual
March 2017
AquaCrop
Plug-in program
(Version 6.0)
Reference manual
March 2017
By Dirk RAES, Pasquale STEDUTO, Theodore C. HSIAO and Elias FERERES
The views expressed in this information product are those of the author(s) and do not necessarily reflect the views or policies of
FAO.
© FAO, 2017
FAO encourages the use, reproduction and dissemination of material in this information product. Except where otherwise indicated,
material may be copied, downloaded and printed for private study, research and teaching purposes, or for use in non-commercial
products or services, provided that appropriate acknowledgement of FAO as the source and copyright holder is given and that FAO’s
endorsement of users’ views, products or services is not implied in any way.
All requests for translation and adaptation rights, and for resale and other commercial use rights should be made via
www.fao.org/contact-us/licence-request or addressed to [email protected].
FAO information products are available on the FAO website (www.fao.org/publications) and can be purchased through publications-
[email protected].
Table of contents
1. Input ...................................................................................................................... 1
2. Running simulation(s) .......................................................................................... 5
3. Output.................................................................................................................... 7
3.1 Seasonal Output...................................................................................................................... 7
3.2 Daily Output ......................................................................................................................... 10
4. Installation .......................................................................................................... 16
iii
AquaCrop plug-in program (Version 6.0)
The calculation procedures in the AquaCrop plug-in program are identical to the AquaCrop
standard window program (Version 6.0) but the plug-in program has no user interface. By running
the program (ACsaV60.EXE) a list of projects, pre-defined in the standard window version of
AquaCrop, are carried out and results are stored in output files. The plug-in program can be used
in applications where iterative runs are required (e.g. GIS environment).
1. Input
In the absence of a user interface only pre-defined simulation runs can be carried out in the
AquaCrop plug-in program. Therefore the input need to consist of project files, which contains all
the required information for a simulation run (Tab.1). Project files are text files which are
composed1 by the standard window AquaCrop program (i.e. the AquaCrop model with the user
interface) when creating projects. Project files can also be created by the user as long as the
structure of the text file is respected.
To run the projects in the plug-in program, the created project files need to be copied in the LIST
subdirectory of the plug-in version:
If the project files were created in a standard window AquaCrop program, copy the project files
from the DATA subdirectory (of the AquaCrop window program where they were created) to
the LIST subdirectory of the plug-in version (Fig. 1);
If the project files were created by the user, paste the project files in the LIST subdirectory of
the plug-in version.
Since the project files contain all information to run the simulations (Tab. 2), the data files
containing the characteristics of the selected environment (climate, crop, soil profile, groundwater
table, field and irrigation management) and the files with the corresponding initial and off-season
conditions, need not to be copied to the LIST directory. The only restriction is that these data files
are stored in a directory of the same computer on which the plug-in program runs. Information in
the project files will guide the plug-in program to the directories where the data files are stored
(Fig. 1).
Project files of previous AquaCrop versions can be used in Version 6.0 of the AquaCrop plug-in
program.
1
Section 2.19 ‘Project characteristics’ of Chapter 2 ‘Users guide’ of the reference manual of
AquaCrop describes how projects are created and updated.
1
Table 1. – The content of a Project file (files with extension ‘PRO’ or ‘PRM’)
A project file is a text file which contains all the required information for a simulation run.
Distinction is made between projects containing the required information for a single simulation
run (with ‘PRO’ as the filename extension) and projects consisting of a set of successive runs
(for simulations in successive years), the so called multiple run projects (with ‘PRM’ as the
filename extension). A project file contains (Tab. 2):
the period(s) of the growing cycle (from day 1 after sowing/transplanting to crop maturity);
the simulation period(s): the first and last day of the simulation period which need not to
coincide with the growing cycle;
the file names (with their directory) containing the characteristics of the selected environment
(climate, crop, irrigation management, field management, soil profile and groundwater table
file);
the file names (with their directory) containing the initial and off-season conditions; and
the specific program settings for the run(s).
AquaCrop uses day numbers to specify the start and end of the simulation period and the period of
the growing cycle. The day number refers to the days elapsed since 0th January 1901 at 0 am (Tab.
3).
Table 3. – Number of days elapsed since 0th January 1901, 0 am (The method is valid from
1901 to 2099 only, which is the time range in AquaCrop)
Rules
1. Subtract 1901 from the year
2. Multiply by 365.25
3. According to the month add:
- January : 0
- February : 31
- March : 59.25
- April : 90.25
- May : 120.25
- June : 151.25
- July : 181.25
- August : 212.25
- September : 243.25
- October : 273.25
- November : 304.25
- December : 334.25
4. Add the number of the day within the month
5. Take the integer
Example
For 24 August 1982
1. Subtract 1901 from the year 1982 – 1901 = 81
2. Multiply by 365.25 81 x 365.25 = 29585.25
3. Add 212.25 for August 29585.25 + 212.25 = 29797.5
4. Add the number of the day 29797.5 + 24 = 29821.5
5. Take the integer 29821
Reference
Gommes, R.A. 1983. Pocket computers in agro meteorology. FAO Plant production and
protection paper Nr. 45, Rome, Italy.
Figure 1. – Input and output data for running the AquaCrop plug-in program
(1) INPUT: Project files are copied from the DATA subdirectory of the AquaCrop standard
window program, to the LIST subdirectory of the AquaCrop plug-in program;
(2) While running the projects available in the LIST subdirectory of the AquaCrop plug-in
program, the required data is retrieved from the DATA subdirectory of the AquaCrop standard
window program;
(3) OUTPUT: Simulation results are saved in the OUTP directory of the AquaCrop plug-in
program.
While running the successive projects, the progress of the simulations is displayed (Fig. 2), and
the seasonal and the requested daily simulation results are saved in files in the OUTP directory.
When all projects listed in the LIST directory are run, the program stops automatically.
Figure 2. – Display of the simulation progress: (i) bar gauge: percentage of projects
finalized; (ii) pie gauge: percentage of runs started (in case of multiple run project)
File name: The name of each seasonal output file corresponds with the filename of the
corresponding project file but extended with ‘PROseason’ (for single projects) or ‘PRMseason’
(for multiple projects), and the extension OUT (Tab. 5). There are as many seasonal output
files as project files listed in the LIST directory.
Option for intermediate results: The standard output consists of totals and averages of
climate, crop, soil water and salt parameters over the total simulation period. Additionally daily,
10-daily or monthly intermediate simulation results can be requested. Therefore the user has to
adjust the number specified at the start of the first (and only) line of the
‘AggregationResults.SIM’ text file (file available in the SIM subdirectory). Depending on the
number either none, daily, 10-daily or monthly intermediate simulation results will be provided
next to the final simulation results (Tab. 6).
Table 6. – Example of the AggregationResults.SIM’ text file (file available in the SIM
subdirectory) generating 10-daily intermediate seasonal simulation results
2 : Time aggregation for intermediate results (0 = none ; 1 = daily; 2 = 10-daily; 3 = monthly)
Recorded simulation results: In each seasonal output file there are for each simulation run as
many lines as intermediate results plus one extra line for the totals of the simulation run. The
results are presented in 38 columns (Tab. 7) and contain information of the length and dates of
the simulation period, and the totals for climatic, soil water and soil salinity parameters, for
File name: The name of the daily output files corresponds with the filename of the
corresponding project file but extended with ‘PROday’ (for single projects) or ‘PRMday’ (for
multiple projects), and the extension OUT (Tab. 8). There are as many daily output files as
project files listed in the LIST directory.
Content: The user specifies the daily data that needs to be recorded with the help of codes
(one code per line) in the ‘DailyResults.SIM’ text file (file available in the SIM subdirectory).
The number of codes (specified in successive lines), and the value of the code (specified at the
start of each of the successive lines) determine the content of the output (Tab. 9):
- 1 : Various parameters of the soil water balance. When net irrigation is calculated column
8 (Irri) contains the daily net irrigation requirement;
- 2 : Crop development and production;
- 3 : Soil water content in the soil profile and root zone;
- 4: Soil salinity in the soil profile and root zone;
- 5 : Soil water content at various depths of the soil profile;
- 6 : Soil salinity at various depths of the soil profile;
- 7 : Climate input parameters
In the absence of the ‘DailyResults.SIM’ file, no daily results will be provided.
Structure: In each daily output file there are for each simulation run as many lines as days in
the simulation period. The individual runs of a multiple projects (PRM) are separated by an
empty line and the Run number. The number of columns depend on the daily data that needs
to be recorded and can be up to 95 column if all daily results are requested (Tab. 10).
IF Code 3: Soil water content in the soil profile and root zone
45 WC(x.xx) Water content total soil profile mm 10:1 (REAL)
with (x.xx): the soil depth in meter
46 Wr(x.xx) Water content in maximum effective root mm 9:1 (REAL)
zone
with (x.xx): the maximum effective root
zone
47 Z Effective rooting depth m 8:2 (REAL)
48 Wr Water content in effective root zone mm 8:1 (REAL)
49 Wr(SAT) Water content in effective root zone if mm 10:1 (REAL)
saturated
50 Wr(FC) Water content in effective root zone at mm 10:1 (REAL)
field capacity
51 Wr(exp) Water content in effective root zone at mm 10:1 (REAL)
upper threshold for leaf expansion
52 Wr(sto) Water content in effective root zone at mm 10:1 (REAL)
upper threshold for stomatal closure
53 Wr(sen) Water content in effective root zone at mm 10:1 (REAL)
upper threshold for early canopy
senescence
54 Wr(PWP) Water content in effective root zone at mm 10:1 (REAL)
permanent wilting point
To run AquaCrop Plug-In, the required data files to run the list of projects should be available on
the PC. If the files were created through the user interface of the AquaCrop standard window
program they will be in the DATA subdirectory of AquaCrop. If so, the AquaCrop standard
window program and the AquaCrop Plug-In program should be on the same PC.
Copying the AquaCrop standard window and Plug-In program to appropriate folders on
a 64-bit PC
1. Copy the zipped files to the PC;
2. Unzip;
3. Copy the full content of the unzipped file:
- for the AquaCrop standard window program it consists of files and 5 subdirectories with
more files;
- for the AquaCrop Plug-In program it consists of files and the subdirectories LIST (which
is empty), OUTP and SIMUL
4. Paste the full content in a directory (folder) of the PC:
- for example C:\FAO\AquaCrop for the AquaCrop standard window program;
- for example C:\FAO\ACsaV60 for the AquaCrop Plug-In program.
C:\FAO\AquaCrop
the AquaCrop.EXE file (the executable file, to launch the standard window program);
and five subdirectories:
- DATA (default subdirectory for the input files);
- IMPORT (default subdirectory for text files with climatic data);
- OBS (default subdirectory for the field observations files);
- OUTP (default subdirectory for the output files);
- SIMUL (subdirectory for simulation purposes, containing between other files the
MaunaLoa.CO2 file, files with default project settings (*.PAR), and SOILS.DIR (a file with
default values for soil characteristics).
C:\FAO\ACsaV60
the ACsaV60.EXE file (the executable file, to launch the Plug-In program);
and three subdirectories:
- LIST (subdirectory in which the copied project files should be stored);
- OUTP (subdirectory, where simulation results will be stored);
- SIMUL (subdirectory, which contains Manauloa.CO2 and eventually the
‘AggregationResults.SIM’ and the ‘DailyResults.SIM’ text files in which the options for the
content of the output files are specified. In the absence of the ‘AggregationResults.SIM’ file no
intermediate results will be provided. In the absence of ‘DailyResults.SIM’, no daily results
will be provided.