OR/14/007 Model files - Revision history

Ajhil: /* 5.2.4 Evaluation input files */

2021-10-22T08:40:27Z

5.2.4 Evaluation input files

← Older revision		Revision as of 09:40, 22 October 2021
Line 408:		Line 408:
	</center>		</center>

	===~~5.2.4~~ Evaluation input files===		===Evaluation input files===
	In evaluation mode, AquiMod requires the user to specify one or more parameter sets using input text files for each module component. These files must be located in the Evaluation folder and they follow a standard naming convention: *_eval.txt where the asterisk should be replaced by the component name. Table 5.5 provides an example of the FAO_eval.txt file. Here only a single parameter set is defined, but multiple parameter sets can be included on separate lines (e.g. see Section 6.2).		In evaluation mode, AquiMod requires the user to specify one or more parameter sets using input text files for each module component. These files must be located in the Evaluation folder and they follow a standard naming convention: *_eval.txt where the asterisk should be replaced by the component name. Table 5.5 provides an example of the FAO_eval.txt file. Here only a single parameter set is defined, but multiple parameter sets can be included on separate lines (e.g. see Section 6.2).

Ajhil: /* 5.2.1 Observations.txt */

2021-10-20T08:56:27Z

5.2.1 Observations.txt

← Older revision		Revision as of 09:56, 20 October 2021
Line 10:		Line 10:
	==Input files==		==Input files==

	===~~5.2.1~~ Observations.txt===		===Observations.txt===
	Before running AquiMod, the user must specify four observation time-series as shown in Table 5.1. These time-series can be summarised as follows:		Before running AquiMod, the user must specify four observation time-series as shown in Table 5.1. These time-series can be summarised as follows:
	* '''Climate (rainfall and PET)'''		* '''Climate (rainfall and PET)'''

Ajhil at 08:55, 20 October 2021

2021-10-20T08:55:46Z

← Older revision		Revision as of 09:55, 20 October 2021
Line 6:		Line 6:
	All of the information required to configure and run AquiMod is stored in a series of text files within a defined folder structure (Figure 5.1). The Observations.txt file contains all of the available observational data including rainfall, PET, groundwater level and abstraction rates. The Input.txt file allows the user to specify a number of options such as which module components and simulation mode they wish to use. The files stored in the Calibration and Evaluation folders are only used when AquiMod is set to run in these respective modes. They contain ranges or specific parameter values to be used by AquiMod when running in calibration and evaluation mode respectively. Finally, the Output folder is where all model outputs are generated.		All of the information required to configure and run AquiMod is stored in a series of text files within a defined folder structure (Figure 5.1). The Observations.txt file contains all of the available observational data including rainfall, PET, groundwater level and abstraction rates. The Input.txt file allows the user to specify a number of options such as which module components and simulation mode they wish to use. The files stored in the Calibration and Evaluation folders are only used when AquiMod is set to run in these respective modes. They contain ranges or specific parameter values to be used by AquiMod when running in calibration and evaluation mode respectively. Finally, the Output folder is where all model outputs are generated.

	[[Image:14007 fig5.1.png\|thumb\|center\|500px\|'''Figure 5.1''' Folder structure of AquiMod.]]		[[Image:14007 fig5.1.png\|thumb\|center\|500px\|'''Figure 5.1'''    Folder structure of AquiMod.]]

	==Input files==		==Input files==
Line 24:		Line 24:
	The number of observations must also be input on line 2. In the example shown in Table 5.1, a total of 540 time-steps are specified which run from January 1961.		The number of observations must also be input on line 2. In the example shown in Table 5.1, a total of 540 time-steps are specified which run from January 1961.

			<center>
	{\| class="wikitable"		{\| class="wikitable"
			\|+ Table 5.1    Example Observations.txt file.
	\|+ Table 5.1 Example Observations.txt file.
	\| '''Line number'''		\| '''Line number'''
	\| colspan="7" \| '''File text'''		\| colspan="7" \| '''File text'''
Line 111:		Line 111:
	\| .		\| .
	\|}		\|}
			</center>

	The Observations.txt file can also be used to specify a number of other conditions including:		The Observations.txt file can also be used to specify a number of other conditions including:
Line 123:		Line 124:
	As well as initialising the model with the observed groundwater levels, it is also possible to impose observed groundwater levels mid-simulation. By doing so, the model discards the simulated level for that time-step and uses the observed level instead. This can be done at one or more time-steps by placing an asterisk at the end of the corresponding row(s) in Observations.txt (Table 5.2).		As well as initialising the model with the observed groundwater levels, it is also possible to impose observed groundwater levels mid-simulation. By doing so, the model discards the simulated level for that time-step and uses the observed level instead. This can be done at one or more time-steps by placing an asterisk at the end of the corresponding row(s) in Observations.txt (Table 5.2).

			<center>
	{\| class="wikitable"		{\| class="wikitable"
	\|+ Table 5.2 Imposing groundwater levels in the Observations.txt file.		\|+ Table 5.2    Imposing groundwater levels in the Observations.txt file.
	\| '''Line number'''		\| '''Line number'''
	\| colspan="8" \|'''File text'''		\| colspan="8" \|'''File text'''
Line 210:		Line 212:
	\| .		\| .
	\|}		\|}
			</center>

	===Input.txt===		===Input.txt===
Line 240:		Line 243:
	Here, the user can specify if they wish output files to be written for each model component. When running in calibration mode, a single file is output for each component. In evaluation mode, a separate file is output for each model component and model run which may slow down the overall model run-time.		Here, the user can specify if they wish output files to be written for each model component. When running in calibration mode, a single file is output for each component. In evaluation mode, a separate file is output for each model component and model run which may slow down the overall model run-time.

			<center>
	{\| class="wikitable"		{\| class="wikitable"
	\|+ Table 5.3 Example Input.txt file.		\|+ Table 5.3    Example Input.txt file.
	\| '''Line number'''		\| '''Line number'''
	\| '''File text'''		\| '''File text'''
Line 362:		Line 366:
	\| N = no do not write output file		\| N = no do not write output file
	\|}		\|}
			</center>

	===Calibration input files===		===Calibration input files===
Line 368:		Line 373:
	Note that template files for all module components can be downloaded from the AquiMod website.		Note that template files for all module components can be downloaded from the AquiMod website.

			<center>
	{\| class="wikitable"		{\| class="wikitable"
	\|+ Table 5.4 Example of the FAO_calib.txt calibration input file format. The field capacity (line 2) is fixed while the root depth (line 8) will change for each calibration run.		\|+ Table 5.4    Example of the FAO_calib.txt calibration input file format. The field capacity (line 2) is fixed while the root depth (line 8) will change for each calibration run.
	! Line number \|\| File text \|\| Description		! Line number \|\| File text \|\| Description
	\|-		\|-
Line 400:		Line 406:
	\| 14 \|\| 0.7 0.9 \|\| Minimum and maximum value		\| 14 \|\| 0.7 0.9 \|\| Minimum and maximum value
	\|}		\|}
			</center>

	===5.2.4 Evaluation input files===		===5.2.4 Evaluation input files===
	In evaluation mode, AquiMod requires the user to specify one or more parameter sets using input text files for each module component. These files must be located in the Evaluation folder and they follow a standard naming convention: *_eval.txt where the asterisk should be replaced by the component name. Table 5.5 provides an example of the FAO_eval.txt file. Here only a single parameter set is defined, but multiple parameter sets can be included on separate lines (e.g. see Section 6.2).		In evaluation mode, AquiMod requires the user to specify one or more parameter sets using input text files for each module component. These files must be located in the Evaluation folder and they follow a standard naming convention: *_eval.txt where the asterisk should be replaced by the component name. Table 5.5 provides an example of the FAO_eval.txt file. Here only a single parameter set is defined, but multiple parameter sets can be included on separate lines (e.g. see Section 6.2).

			<center>
	{\| class="wikitable"		{\| class="wikitable"
	\|+ Table 5.5 Example of FAO_eval.txt file.		\|+ Table 5.5    Example of FAO_eval.txt file.
	\| '''Line number'''		\| '''Line number'''
	\| '''File text'''		\| '''File text'''
Line 430:		Line 438:
	\| Parameter values		\| Parameter values
	\|}		\|}
			</center>

	==Onput files==		==Onput files==
Line 439:		Line 448:
	Note that the file structure is identical to the evaluation input files. This allows for easy transfer between calibration and evaluation modes (see Section 6.2).		Note that the file structure is identical to the evaluation input files. This allows for easy transfer between calibration and evaluation modes (see Section 6.2).

			<center>
	{\| class="wikitable"		{\| class="wikitable"
	\|+ Table 5.6 Example of FAO_calib.out file.		\|+ Table 5.6    Example of FAO_calib.out file.
	\| '''Line number'''		\| '''Line number'''
	\| '''File text'''		\| '''File text'''
Line 491:		Line 500:
	\| .		\| .
	\|}		\|}
			</center>

	In conjunction with the module component output files, a fit_calib.out file is also produced (see example in Table 5.7) which lists the corresponding objective function scores of the acceptable parameter sets obtained.		In conjunction with the module component output files, a fit_calib.out file is also produced (see example in Table 5.7) which lists the corresponding objective function scores of the acceptable parameter sets obtained.

			<center>
	{\| class="wikitable"		{\| class="wikitable"
	\|+ Table 5.7 Example of fit_calib.out file produced by AquiMod using the NSE objective function.		\|+ Table 5.7    Example of fit_calib.out file produced by AquiMod using the NSE objective function.
	\| '''Line number'''		\| '''Line number'''
	\| '''File text'''		\| '''File text'''
Line 528:		Line 539:
	\| .		\| .
	\|}		\|}
			</center>

	===Evaluation output files===		===Evaluation output files===
Line 534:		Line 546:
	A corresponding fit_eval.out file is also produced which returns the objective function score for each parameter set. The structure of this file is identical to that for a calibration run (Table 5.6).		A corresponding fit_eval.out file is also produced which returns the objective function score for each parameter set. The structure of this file is identical to that for a calibration run (Table 5.6).

			<center>
	{\| class="wikitable"		{\| class="wikitable"
	\|+ Table 5.8 Example of Q3K3S1_TimeSeries1.out from an evaluation run.		\|+ Table 5.8    Example of Q3K3S1_TimeSeries1.out from an evaluation run.
	\| '''Line number'''		\| '''Line number'''
	\| '''File text'''		\| '''File text'''
Line 626:		Line 639:
	\| .		\| .
	\|}		\|}
			</center>

	[[Category:OR/14/007_AquiMod User Manual (v1.0)\| 05]]		[[Category:OR/14/007_AquiMod User Manual (v1.0)\| 05]]

Dbk at 15:51, 29 July 2015

2015-07-29T15:51:14Z

← Older revision		Revision as of 16:51, 29 July 2015
Line 229:		Line 229:
	Due to the fact that the soil and unsaturated zone components are initiated without any water in them, there is an initial wetting-up period, or spin-up period where AquiMod may not be able to simulate the groundwater level time-series adequately which can result in poor optimization of the model parameters when running in calibration mode. To prevent this, the length of this period should be specified as a number of time-steps. AquiMod will then ignore this portion of the simulation when calculating the chosen objective function.		Due to the fact that the soil and unsaturated zone components are initiated without any water in them, there is an initial wetting-up period, or spin-up period where AquiMod may not be able to simulate the groundwater level time-series adequately which can result in poor optimization of the model parameters when running in calibration mode. To prevent this, the length of this period should be specified as a number of time-steps. AquiMod will then ignore this portion of the simulation when calculating the chosen objective function.

	The length of this period is likely to depend on the choice of model structure and parameters. Past experience has shown that the unsaturated zone component often has the longest ~~“memory”~~ of the three components in AquiMod. For example, when using the Weibull unsaturated zone component, the n parameter, which defines the number of time-steps over which recharge is spread, can also be used to define the spin-up period (see section 6.1 for further information on defining the spin-up period).		The length of this period is likely to depend on the choice of model structure and parameters. Past experience has shown that the unsaturated zone component often has the longest 'memory' of the three components in AquiMod. For example, when using the Weibull unsaturated zone component, the n parameter, which defines the number of time-steps over which recharge is spread, can also be used to define the spin-up period (see section 6.1 for further information on defining the spin-up period).
	* '''Acceptable model threshold'''		* '''Acceptable model threshold'''

Line 495:		Line 495:

	{\| class="wikitable"		{\| class="wikitable"
	\|+ Table 5.7 Example of fit_calib.out file produced by AquiMod using the NSE objective function.~~'''~~		\|+ Table 5.7 Example of fit_calib.out file produced by AquiMod using the NSE objective function.
	\| '''Line number'''		\| '''Line number'''
	\| '''File text'''		\| '''File text'''

Dbk: Protected "OR/14/007 Model files" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading]

2015-03-26T12:51:37Z

Protected "OR/14/007 Model files" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading]

← Older revision		Revision as of 13:51, 26 March 2015
(No difference)

Dbk: /* General file and folder structure */

2015-03-26T12:46:08Z

General file and folder structure

← Older revision		Revision as of 13:46, 26 March 2015
Line 6:		Line 6:
	All of the information required to configure and run AquiMod is stored in a series of text files within a defined folder structure (Figure 5.1). The Observations.txt file contains all of the available observational data including rainfall, PET, groundwater level and abstraction rates. The Input.txt file allows the user to specify a number of options such as which module components and simulation mode they wish to use. The files stored in the Calibration and Evaluation folders are only used when AquiMod is set to run in these respective modes. They contain ranges or specific parameter values to be used by AquiMod when running in calibration and evaluation mode respectively. Finally, the Output folder is where all model outputs are generated.		All of the information required to configure and run AquiMod is stored in a series of text files within a defined folder structure (Figure 5.1). The Observations.txt file contains all of the available observational data including rainfall, PET, groundwater level and abstraction rates. The Input.txt file allows the user to specify a number of options such as which module components and simulation mode they wish to use. The files stored in the Calibration and Evaluation folders are only used when AquiMod is set to run in these respective modes. They contain ranges or specific parameter values to be used by AquiMod when running in calibration and evaluation mode respectively. Finally, the Output folder is where all model outputs are generated.

	[[Image:14007 fig5.1.png\|thumb\|center\|~~300px~~\|'''Figure 5.1''' Folder structure of AquiMod.]]		[[Image:14007 fig5.1.png\|thumb\|center\|500px\|'''Figure 5.1''' Folder structure of AquiMod.]]

	==Input files==		==Input files==

Dbk: /* General file and folder structure */

2015-03-26T12:45:58Z

General file and folder structure

← Older revision		Revision as of 13:45, 26 March 2015
Line 6:		Line 6:
	All of the information required to configure and run AquiMod is stored in a series of text files within a defined folder structure (Figure 5.1). The Observations.txt file contains all of the available observational data including rainfall, PET, groundwater level and abstraction rates. The Input.txt file allows the user to specify a number of options such as which module components and simulation mode they wish to use. The files stored in the Calibration and Evaluation folders are only used when AquiMod is set to run in these respective modes. They contain ranges or specific parameter values to be used by AquiMod when running in calibration and evaluation mode respectively. Finally, the Output folder is where all model outputs are generated.		All of the information required to configure and run AquiMod is stored in a series of text files within a defined folder structure (Figure 5.1). The Observations.txt file contains all of the available observational data including rainfall, PET, groundwater level and abstraction rates. The Input.txt file allows the user to specify a number of options such as which module components and simulation mode they wish to use. The files stored in the Calibration and Evaluation folders are only used when AquiMod is set to run in these respective modes. They contain ranges or specific parameter values to be used by AquiMod when running in calibration and evaluation mode respectively. Finally, the Output folder is where all model outputs are generated.

	[[Image:14007 fig5.1.~~jpg~~\|thumb\|center\|300px\|'''Figure 5.1''' Folder structure of AquiMod.]]		[[Image:14007 fig5.1.png\|thumb\|center\|300px\|'''Figure 5.1''' Folder structure of AquiMod.]]


	==Input files==		==Input files==

Dbk: /* Calibration output files */

2015-03-25T16:19:25Z

Calibration output files

← Older revision		Revision as of 17:19, 25 March 2015
Line 443:		Line 443:
	{\| class="wikitable"		{\| class="wikitable"
	\|+ Table 5.6 Example of FAO_calib.out file.		\|+ Table 5.6 Example of FAO_calib.out file.
	\| Line number		\| '''Line number'''
	\| File text		\| '''File text'''
	\|		\|
	\|		\|
	\|		\|
	\| Description		\| '''Description'''
	\|-		\|-
	\| 1		\| 1
Line 497:		Line 497:
	{\| class="wikitable"		{\| class="wikitable"
	\|+ Table 5.7 Example of fit_calib.out file produced by AquiMod using the NSE objective function.'''		\|+ Table 5.7 Example of fit_calib.out file produced by AquiMod using the NSE objective function.'''
	\| '''Line number		\| '''Line number'''
	\| File text		\| '''File text'''
	\| Description number'''		\| '''Description number'''
	\|-		\|-
	\| 1		\| 1

Dbk: /* Evaluation output files */

2015-03-25T16:18:52Z

Evaluation output files

← Older revision		Revision as of 17:18, 25 March 2015
Line 609:		Line 609:
	\| .		\| .
	\| .		\| .
			\|
	\|		\|
	\|		\|
Line 616:		Line 617:
	\|		\|
	\|-		\|-
	\|
	\| .		\| .
	\| .		\| .
			\|
	\|		\|
	\|		\|

Dbk: /* Calibration output files */

2015-03-25T16:18:14Z

Calibration output files

Show changes