start:hype_file_reference:info.txt
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
start:hype_file_reference:info.txt [2018/11/16 15:21] cpers [Table] |
start:hype_file_reference:info.txt [2019/10/25 10:54] cpers [Table] |
||
|---|---|---|---|
| Line 45: | Line 45: | ||
| | ''instate'' | //Y/N// | defines whether a starting state is to be read. //Y// for yes, //N// for no. Default is //N//. For yes, the file with a previously saved model state must exist (state_saveyyyymmdd[HHMM].txt) date in file name must be the same as ''bdate''. | | | ''instate'' | //Y/N// | defines whether a starting state is to be read. //Y// for yes, //N// for no. Default is //N//. For yes, the file with a previously saved model state must exist (state_saveyyyymmdd[HHMM].txt) date in file name must be the same as ''bdate''. | | ||
| | ''outstatedate'' | //date-time// | defines that a starting state will be output for the given date. The date should be in the format yyyy-mm-dd [HH:MM]. The starting state is saved in the file state_saveyyyymmdd[HHMM].txt. The default is that no output state is written. Maximum 10 starting states (10 dates) may be written. The dates may be written on same or different rows. In the latter case with this code on every row. | | | ''outstatedate'' | //date-time// | defines that a starting state will be output for the given date. The date should be in the format yyyy-mm-dd [HH:MM]. The starting state is saved in the file state_saveyyyymmdd[HHMM].txt. The default is that no output state is written. Maximum 10 starting states (10 dates) may be written. The dates may be written on same or different rows. In the latter case with this code on every row. | | ||
| - | | ''substance'' | //string// | gives the substances to be simulated. One or several of: //N P C S T1 T2//. N - nitrogen, P - phosphorus, C - organic carbon, S - total suspended sediment, T1 - tracers, and T2 - water temperature. Substances may be defined on one or several rows (with the code preceding the substance on each row) with one or several substances per row (separated by space). The default is to simulate no substances, only water. | | + | | ''substance'' | //string// | gives the substances to be simulated. One or several of: //N P C S T1 T2//. N - nitrogen, P - phosphorus, C - organic carbon, S - total suspended sediment, T1 - tracer, and T2 - water temperature. Substances may be defined on one or several rows (with the code preceding the substance on each row) with one or several substances per row (separated by space). The default is to simulate no substances, only water. | |
| | ''calibration'' | //Y/N// | defines whether or not automatic calibration is to be done. //Y// for calibration. Default is //N//. Calibration method and parameters are defined in file [[start:hype_file_reference:optpar.txt|optpar.txt]]. Note that reading of initial state does not work with automatic calibration of parameters rivvel and damp, or with the ''soilstretch'' functionality. | | | ''calibration'' | //Y/N// | defines whether or not automatic calibration is to be done. //Y// for calibration. Default is //N//. Calibration method and parameters are defined in file [[start:hype_file_reference:optpar.txt|optpar.txt]]. Note that reading of initial state does not work with automatic calibration of parameters rivvel and damp, or with the ''soilstretch'' functionality. | | ||
| | ''regestimate'' | //Y/N// | defines if regional estimated parameters calculated by regression is used. This option requires the files [[start:hype_file_reference:reg_par.txt|reg_par.txt]], [[start:hype_file_reference:CatchDes.txt|CatchDes.txt]] and [[start:hype_file_reference:CatchGroup.txt|CatchGroup.txt]]. //Y// for yes or //N// for no. Default is //N//. | | | ''regestimate'' | //Y/N// | defines if regional estimated parameters calculated by regression is used. This option requires the files [[start:hype_file_reference:reg_par.txt|reg_par.txt]], [[start:hype_file_reference:CatchDes.txt|CatchDes.txt]] and [[start:hype_file_reference:CatchGroup.txt|CatchGroup.txt]]. //Y// for yes or //N// for no. Default is //N//. | | ||
| Line 103: | Line 103: | ||
| |''infiltration''|//0/1/2/3//|defines which infiltration model should be used. Default is the basic infiltration model of HYPE. For infiltration model 1 infiltration is limited by frozen soils. Infiltration model 2 is an alternative model where infiltration and percolation is added after runoff and evaporation is calculated. Model 3 is a combination of model 2 and 1.| | |''infiltration''|//0/1/2/3//|defines which infiltration model should be used. Default is the basic infiltration model of HYPE. For infiltration model 1 infiltration is limited by frozen soils. Infiltration model 2 is an alternative model where infiltration and percolation is added after runoff and evaporation is calculated. Model 3 is a combination of model 2 and 1.| | ||
| |''erosionmodel''|//0/1//|defines which soil erosion model to be used for simulation of suspended sediments. Default (0) is similar to erosion of PP (uses CropData), alternative (1) is based on HBV-sed.| | |''erosionmodel''|//0/1//|defines which soil erosion model to be used for simulation of suspended sediments. Default (0) is similar to erosion of PP (uses CropData), alternative (1) is based on HBV-sed.| | ||
| - | |''wetlandmodel''|//0/1//|defines if wetland model is to be simulated. Default (0) is no wetland model, (1) is river wetland nutrient model.| | + | |''wetlandmodel''|//0/1/2//|defines if wetland model is to be simulated. Default (0) is no wetland model, (1) is river wetland nutrient model, (2) wetlands as classes with water regulation capabilities.| |
| |''soilleakage''|//0/1//|defines if soil leakage concentrations is to be calculated or read from file. Default (0) is calculation, (1) is reading monthly values for each subbasin.| | |''soilleakage''|//0/1//|defines if soil leakage concentrations is to be calculated or read from file. Default (0) is calculation, (1) is reading monthly values for each subbasin.| | ||
| </sortable> | </sortable> | ||
| Line 118: | Line 118: | ||
| * **water balances** of subbasin water stores for each time step | * **water balances** of subbasin water stores for each time step | ||
| - | The principal outputs are specified with two codes in //info.txt//, first code giving the output type and second specifying content options. If output with different mean period is to be had by the same output type, it is possible to number the outputs consequtively between the two codes. After the codes follow the arguments. Content option codes are identical for all basic output types. All outputs are technically optional. | + | The principal outputs are specified with two codes in //info.txt//, first code giving the output type and second specifying content options. After the codes follow the arguments. Content option codes are identical for all basic output types. All outputs are technically optional. |
| - | It is possible to get output for several different meanperiods for the same type of output (basin- , region- or time-output) by specifying several groups of the same type of output with a ordinal number between **Code 1** and **Code 2**. See example below the table. The files will then have a suffix to their name to separate them, e.g. //timeCRUN_DD.txt//. If only one non-numbered group is used no meanperiod suffix will be added to the file(s). The number between **Code 1** and **Code 2** is also used to hold together classoutput information for different variables/groups/meanperiods. | + | It is possible to get output for several different aggregation periods for the same type of output (basin- , region- or time-output) by specifying several groups of the same type of output with a ordinal number between **Code 1** and **Code 2**. See example below the table. The files will then have a suffix to their name to separate them, e.g. //timeCRUN_DD.txt//. If only one non-numbered group is used no meanperiod suffix will be added to the file(s). The number between **Code 1** and **Code 2** is also used to hold together classoutput information for different variables/groups/meanperiods. |
| Line 134: | Line 134: | ||
| <sortable> | <sortable> | ||
| - | ^ Code 1 ^ Code 2 ^ Argument ^ Description ^ | + | ^ Code 1 ^ Code 2 ^ Argument ^ Description ^ |
| - | |''basinoutput \\ mapoutput \\ timeoutput \\ regionoutput \\ classoutput''|''variable''|//ID string(s)//|defines variables to be written. Multiple variables are separated by blanks or tabs. The order of the variables defines the order in [[start:hype_file_reference:XXXXXXX.txt|basin output files]]. For [[start:hype_file_reference:timeXXXX.txt|time output files]] and [[start:hype_file_reference:mapXXXX.txt|map output files]] the order is irrelevant (one file per variable returned). Both internal and output variables are available, see [[start:hype_file_reference:info.txt:variables|Complete list of variables]]. One or several rows may be given.| | + | | ''basinoutput \\ mapoutput \\ timeoutput \\ regionoutput \\ classoutput'' | ''variable'' | //ID string(s)// | defines variables to be written. Multiple variables are separated by blanks or tabs. The order of the variables defines the order in [[start:hype_file_reference:XXXXXXX.txt|basin output files]]. For [[start:hype_file_reference:timeXXXX.txt|time output files]] and [[start:hype_file_reference:mapXXXX.txt|map output files]] the order is irrelevant (one file per variable returned). Both internal and output variables are available, see [[start:hype_file_reference:info.txt:variables|Complete list of variables]]. One or several rows may be given. | |
| - | |''basinoutput \\ mapoutput \\ timeoutput \\ regionoutput \\ classoutput''|''meanperiod''|//0/1/2/3/4/5//|is given to define the period to which results are aggregated for the output. The period is given using codes (see table below). \\ The type of aggregation depends on variable and chosen period: Fluxes are given as sums, storages and states as averages, and concentrations as flow-weighted averages. **Note:** Period 5 aggregates are always means of annual aggregates. The type of aggregation is also documented in the [[start:hype_file_reference:info.txt:variables|list of variables]] in column 'Agg.'. | | + | | ''basinoutput \\ mapoutput \\ timeoutput \\ regionoutput \\ classoutput'' | ''meanperiod'' | //0/1/2/3/4/5// | is given to define the period to which results are aggregated for the output. The period is given using codes, e.g. 1 for daily (see table [[info.txt#aggregation_period_codes|below]]). \\ The type of aggregation depends on variable and chosen period: Fluxes are given as sums, storages and states as averages, and concentrations as flow-weighted averages. It is documented in the [[start:hype_file_reference:info.txt:variables|list of variables]] in column 'Agg.'. | |
| - | |''basinoutput \\ mapoutput \\ timeoutput \\ regionoutput \\ classoutput''|''signfigures''|//integer//|defines the number of significant figures written in the outputs. \\ **Note:** //signfigures// applies to all output variables within one output type. Default is zero and then a fixed number of decimals are used. If set, significant figures and mathematical format are used (e.g 9.5451E-03). Maximum allowed number of significant figures is 10.| | + | | ''basinoutput \\ mapoutput \\ timeoutput \\ regionoutput \\ classoutput'' | ''signfigures'' | //integer// | defines the number of significant figures written in the outputs. Allowed values 2-10. Default is to use a fixed number of decimals. If set, significant figures and mathematical format are used (e.g 9.5451E-03) instead. \\ **Note:** //signfigures// applies to all output variables within one output type. **Note:** //signfigures// less than 4 will round missing value to -1E4. | |
| - | |''basinoutput \\ mapoutput \\ timeoutput \\ regionoutput \\ classoutput''|''decimals''|//integer//|defines a fixed number of decimals written in the outputs, alternative to //signfigures//. Maximum allowed number of decimals is 9. Consider using //signfigures// instead, which is more flexible. \\ **Note:** //decimals// applies to all output variables within one output type. Output variables which contain small numbers and ones which contain large numbers can be impossible to combine in a single ''basinoutput'' combination, because a small number //variable// can require such a large number of //decimals// to give meaningful precision that the total number of digits of the large number variable exceeds HYPE's maximum output width, resulting in the printing of '%%****************%%' strings. A typical example is a combination of substance loads (kg/year) and discharge (m<sup>3</sup>/s).| | + | | ''basinoutput \\ mapoutput \\ timeoutput \\ regionoutput \\ classoutput'' | ''decimals'' | //integer// | defines a fixed number of decimals written in the outputs, alternative to //signfigures//. Maximum allowed number of decimals is 9. Consider using //signfigures// instead, which is more flexible. \\ **Note:** //decimals// applies to all output variables within one output type. Output variables which contain small numbers and ones which contain large numbers can be impossible to combine in a single ''basinoutput'' combination, because a small number //variable// can require such a large number of //decimals// to give meaningful precision that the total number of digits of the large number variable exceeds HYPE's maximum output width, resulting in the printing of '%%****************%%' strings. A typical example is a combination of substance loads (kg/year) and discharge (m<sup>3</sup>/s). | |
| - | |''basinoutput \\ classoutput''|''allbasin''|//NONE//|defines that output is to be written for all subbasins. No further arguments.| | + | | ''basinoutput \\ classoutput'' | ''allbasin'' | //NONE// | defines that output is to be written for all subbasins. No further arguments. | |
| - | |''basinoutput \\ classoutput''|''subbasin''|//integer//|defines one or several SUBIDs (subcatchment IDs) for which output is to be written. One or several rows may be given.| | + | | ''basinoutput \\ classoutput'' | ''subbasin'' | //integer// | defines one or several SUBIDs (subcatchment IDs) for which output is to be written. One or several rows may be given. | |
| - | |''regionoutput''|''outregion''|//integer//|defines one or several OUTREGIDs for which output is to be written. One or several rows may be given. If no row with outregions is defined all outregions will be written.| | + | | ''regionoutput'' | ''outregion'' | //integer// | defines one or several OUTREGIDs for which output is to be written. One or several rows may be given. If no row with outregions is defined all outregions will be written. | |
| - | |''classoutput''|''group''|//name string(s)//|defines which class groups are to be printed for this output. Leave out if default class groups are used.| | + | | ''classoutput'' | ''group'' | //name string(s)// | defines which class groups are to be printed for this output. Leave out if default class groups are used. | |
| - | |''classoutput''|''definegroup''|//name string, integer(s)//|defines which slc-classes are included in the classgroup with this name. The name may be up to 6 letters.| | + | | ''classoutput'' | ''definegroup'' | //name string, integer(s)// | defines which slc-classes are included in the classgroup with this name. The name may be up to 6 letters. | |
| - | |''classoutput''|''definegroup''|//allclass//|define default groups should be used for all classoutput. This means one class per classgroup.| | + | | ''classoutput'' | ''definegroup'' | //allclass// | define default groups should be used for all classoutput. This means one class per classgroup. | |
| - | |''printload''|''''|//Y/N//|defines if output of annual loads is to be written. //Y// for load output. Default is //N//.| | + | | ''printload'' | '''' | //Y/N// | defines if output of annual loads is to be written. //Y// for load output. Default is //N//. | |
| - | |''printwaterbal''|''''|//Y/N//|defines if output of daily (time steply) water balance is to be written. //Y// for yes or //N// for no. Default is //N//.| | + | | ''printwaterbal'' | '''' | //Y/N// | defines if output of daily (time steply) water balance is to be written. //Y// for yes or //N// for no. Default is //N//. | |
| </sortable> | </sortable> | ||
| - | The following example snippet give monthly time series of precipitation, evaporation, local runoff and discharge and daily time series of runoff. The additional file, in this case for daily runoff, is called //timeCRUN_DD.txt//, while the runoff file from the first group is called //timeCRUN_MO.txt//: | + | === Aggregation period codes === |
| - | + | Aggregation period codes (used for ''meanperiod'') and corresponding file name suffix. Simulation period (''5'') aggregates are means of annual aggregates. | |
| - | timeoutput 1 variable prec evap crun cout | + | |
| - | timeoutput 1 meanperiod 3 | + | |
| - | timeoutput 1 decimals 3 | + | |
| - | timeoutput 2 variable crun | + | |
| - | timeoutput 2 meanperiod 1 | + | |
| - | timeoutput 2 decimals 1 | + | |
| - | + | ||
| - | Mean period codes and corresponding file name suffix. | + | |
| ^ Code ^ Suffix ^ Description ^ | ^ Code ^ Suffix ^ Description ^ | ||
| Line 170: | Line 162: | ||
| |''''|''HR''|//hourly//| | |''''|''HR''|//hourly//| | ||
| + | The following example snippet gives daily discharge simulated and observed for two subbasins in the files 0000025.txt and 0000073.txt. It gives monthly time series of precipitation, evaporation, local runoff and discharge and daily time series of runoff. The additional file, in this case for daily runoff, is called //timeCRUN_DD.txt//, while the runoff file from the first group is called //timeCRUN_MO.txt//: | ||
| + | |||
| + | basinoutput variable cout rout | ||
| + | basinoutput meanperiod 1 | ||
| + | basinoutput subbasins 25 73 | ||
| + | timeoutput 1 variable prec evap crun cout | ||
| + | timeoutput 1 meanperiod 3 | ||
| + | timeoutput 1 decimals 3 | ||
| + | timeoutput 2 variable crun | ||
| + | timeoutput 2 meanperiod 1 | ||
| + | timeoutput 2 decimals 1 | ||
| ===== Performance criteria options ===== | ===== Performance criteria options ===== | ||
start/hype_file_reference/info.txt.txt · Last modified: 2024/02/21 08:47 by cpers
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
