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 [2019/10/25 10:51] cpers [Table] |
start:hype_file_reference:info.txt [2020/02/28 10:55] cpers [General] |
||
|---|---|---|---|
| Line 44: | Line 44: | ||
| | ''steplength'' | //string// | defines the length of the time step used in calculations. It consists of an integer followed directly by d, h or min. For example a daily time step is defined as //1d//, while a time step of six hours is defined as //6h//. The code has so far been tested with step lengths //1h//, //6h// and //1d//. Default is 1d.\\ Time steps of a simulation with shorter time step than a day use hour and minute to denote their time. The hour is between 00 and 23. The date-time is the beginning of the time step. For example with 12h time step is the 2 times during a 1 January denoted 2010-01-01 00:00 and 2010-01-01 12:00. | | | ''steplength'' | //string// | defines the length of the time step used in calculations. It consists of an integer followed directly by d, h or min. For example a daily time step is defined as //1d//, while a time step of six hours is defined as //6h//. The code has so far been tested with step lengths //1h//, //6h// and //1d//. Default is 1d.\\ Time steps of a simulation with shorter time step than a day use hour and minute to denote their time. The hour is between 00 and 23. The date-time is the beginning of the time step. For example with 12h time step is the 2 times during a 1 January denoted 2010-01-01 00:00 and 2010-01-01 12:00. | | ||
| | ''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 default is that no output state is written. Maximum 10 dates may be given. The dates may be written on same or different rows. In the latter case, the code first on every row. The starting state is saved in file state_saveyyyymmdd[HHMM].txt. | |
| + | | ''outstatedate all'' | | defines that a starting state will be output for every timestep of the model simulation. Default is that no output state is written. The starting states are saved in files state_saveyyyymmdd[HHMM].txt. | | ||
| + | | ''outstatedate period'' | //date-time// //date-time// | defines that starting state will be output for all time steps within the period between the given dates. The dates should be in the format yyyy-mm-dd [HH:MM]. Default is that no output state is written. The starting states are saved in files state_saveyyyymmdd[HHMM].txt. | | ||
| | ''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. | | | ''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. | | ||
| Line 137: | Line 139: | ||
| | ''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, 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'' | ''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. Default is to use a fixed number of decimals. If set, significant figures and mathematical format are used (e.g 9.5451E-03) instead. Maximum allowed number of significant figures is 10.\\ **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'' | ''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. | | ||
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
