User Tools

Site Tools


start:hype_file_reference:info.txt

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
start:hype_file_reference:info.txt [2018/06/21 13:57]
cpers
start:hype_file_reference:info.txt [2018/11/16 15:21] (current)
cpers [Table]
Line 19: Line 19:
  
 Conventionally,​ info files are sorted according to this order. The following tables describe all possible codes, grouped in the above order. Conventionally,​ info files are sorted according to this order. The following tables describe all possible codes, grouped in the above order.
- 
-===== Model options ===== 
  
 In order to write output files of results for other than daily time steps or the whole simulation period, ''​bdate'',​ ''​cdate'',​ and ''​edate''​ must agree with the period chosen for output, e.g. for monthly output, //cdate// should be the first day of a calendar month and //edate// the last day of a month. This is true also for shorter time steps, e.g. ''​edate''​ should be the last timestep of the date ending the period. In order to write output files of results for other than daily time steps or the whole simulation period, ''​bdate'',​ ''​cdate'',​ and ''​edate''​ must agree with the period chosen for output, e.g. for monthly output, //cdate// should be the first day of a calendar month and //edate// the last day of a month. This is true also for shorter time steps, e.g. ''​edate''​ should be the last timestep of the date ending the period.
Line 37: Line 35:
  
 <​sortable>​ <​sortable>​
-^  Code  ^  Argument ​ ^  Description ​ +^  Code                 ​^  Argument ​          ​^  Description ​                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ​
-|''​modeldir''​|//​directory path//​|Gives the search path to all model input files, with exception of forcing data and initial state if ''​forcingdir''​ is set. Default is the same folder as [[start:​hype_file_reference:​info.txt|info.txt]]. Relative path starts from the info-file folder.| +| ''​modeldir'' ​         | //directory path// ​ | Gives the search path to all model input files, with exception of forcing data and initial state if ''​forcingdir''​ is set. Default is the same folder as [[start:​hype_file_reference:​info.txt|info.txt]]. Relative path starts from the info-file folder. ​                                                                                                                                                                                                                                                                                                                                                                           
-|''​forcingdir''​|//​directory path//​|Gives the search path to forcing files (Pobs, Qobs etc. and ForcKey) and initial state file. Default is ''​modeldir''​. Relative path starts from the info-file folder.| +| ''​forcingdir'' ​       | //directory path// ​ | Gives the search path to forcing files (Pobs, Qobs etc. and ForcKey) and initial state file. Default is ''​modeldir''​. Relative path starts from the info-file folder. ​                                                                                                                                                                                                                                                                                                                                                                                                                                                               
-|''​resultdir''​|//​directory path//​|Gives the search path to the result files (except for hyss.log which is written in the folder of  [[start:​hype_file_reference:​info.txt|info.txt]]). The folder must exist. Default is same folder as [[start:​hype_file_reference:​info.txt|info.txt]]. Relative path starts from the info-file folder.| +| ''​resultdir'' ​        ​| //directory path// ​ | Gives the search path to the result files (except for hyss.log which is written in the folder of  [[start:​hype_file_reference:​info.txt|info.txt]]). The folder must exist. Default is same folder as [[start:​hype_file_reference:​info.txt|info.txt]]. Relative path starts from the info-file folder. ​                                                                                                                                                                                                                                                                                                                               
-|''​**bdate**''​|//​date-time//​|Gives the start date for simulation. Format: yyyy-mm-dd [HH:MM].| +| ''​**bdate**'' ​        ​| //​date-time// ​      ​| Gives the start date for simulation. Format: yyyy-mm-dd [HH:​MM]. ​                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ​
-|''​cdate''​|//​date-time//​|Gives the start date for the output of results and calculations of criteria. Format: yyyy-mm-dd [HH:MM]. Defaults to ''​bdate''​.| +| ''​cdate'' ​            ​| //​date-time// ​      ​| Gives the start date for the output of results and calculations of criteria. Format: yyyy-mm-dd [HH:MM]. Defaults to ''​bdate''​. ​                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
-|''​**edate**''​|//​date-time//​|Gives the last date for the simulation (including this date). Format: yyyy-mm-dd [HH:MM].| +| ''​**edate**'' ​        ​| //​date-time// ​      ​| Gives the last date for the simulation (including this date). Format: yyyy-mm-dd [HH:​MM]. ​                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           
-|''​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 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// (inorganic (IN) and organic ​nitrogen ​(ON))//P// (soluble reactive ​phosphorus ​(SP) and particulate phosphorus (PP))//C// (organic carbon)//S// (suspended sediment ​(SS) and algae (AE))//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. Substances may be given with either upper- or lower-case letters. 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//​. ​                                                                                                                                                                                                                                                                                          ​
-|''​readformat''​|//​0/​1//​|handles several different formats of input data. The default (0) is ASCII-files with dates in the format yyyy-mm-dd and normal months. ‘1’ is ASCII-files with date in MATLAB format| +| ''​readformat'' ​       | //​0/​1// ​            ​| handles several different formats of input data. The default (0) is ASCII-files with dates in the format yyyy-mm-dd and normal months. ‘1’ is ASCII-files with date in MATLAB format ​                                                                                                                                                                                                                                                                                                                                                                                                                                                ​
-|''​writeformat''​|//​0/​1//​|Set to 1 to write output in a format suitable for MATLAB (i.e. date without ‘-‘, ​ ‘%’ in front of the column headings). Default is 0.| +| ''​writeformat'' ​      ​| //​0/​1// ​            ​| Set to 1 to write output in a format suitable for MATLAB (i.e. date without ‘-‘, ​ ‘%’ in front of the column headings). Default is 0.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
-|''​readoutregion''​|//​Y/​N//​|defines if [[start:​hype_file_reference:​Outregions.txt|Outregions.txt]] is present and should be used. Give Y to use the file, or N (default).| +| ''​readoutregion'' ​    ​| //​Y/​N// ​            ​| defines if [[start:​hype_file_reference:​Outregions.txt|Outregions.txt]] is present and should be used. Give Y to use the file, or N (default). ​                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       
-|''​resseqnr''​|//​Y/​N//​|determines if result files have the sequence number as a suffix to their name, if HYPE is run with flag '​-sequence',​ see [[:​start&#​how_to_run_hype|How to run HYPE]]. Default is yes. Give No to remove the number from result file names.| +| ''​resseqnr'' ​         | //​Y/​N// ​            ​| determines if result files have the sequence number as a suffix to their name, if HYPE is run with flag '​-sequence',​ see [[:​start&#​how_to_run_hype|How to run HYPE]]. Default is yes. Give No to remove the number from result file names. ​                                                                                                                                                                                                                                                                                                                                                                                          ​
-|''​readdaily''​|//​Y/​N//​|defines if time series input data should be read every day. The default is to read all data at the beginning of the simulation (//N//). However, for large input data files, memory limitations can preclude this. Set to ’Y’ to read input data every day instead.| +| ''​readdaily'' ​        ​| //​Y/​N// ​            ​| defines if time series input data should be read every day. The default is to read all data at the beginning of the simulation (//N//). However, for large input data files, memory limitations can preclude this. Set to ’Y’ to read input data every day instead. ​                                                                                                                                                                                                                                                                                                                                                                 
-|''​readobsid''​|//​Y/​N//​|defines if columns pobsid/​tobsid/​etc. in [[start:​hype_file_reference:​ForcKey.txt|ForcKey.txt]] will be used. Give //Y// to use the columns if they exist (default), or //N// to force the use of subid as connection between forcing data columns and and GeoData.| +| ''​readobsid'' ​        ​| //​Y/​N// ​            ​| defines if columns pobsid/​tobsid/​etc. in [[start:​hype_file_reference:​ForcKey.txt|ForcKey.txt]] will be used. Give //Y// to use the columns if they exist (default), or //N// to force the use of subid as connection between forcing data columns and and GeoData. ​                                                                                                                                                                                                                                                                                                                                                                  ​
-|''​readsfobs''​|//​Y/​N//​|defines if [[start:​hype_file_reference:​SFobs.txt|SFobs.txt]] with observed snowfall fractions is present and should be used. Give //Y// to use the file, or //N// (default).| +| ''​readsfobs'' ​        ​| //​Y/​N// ​            ​| defines if [[start:​hype_file_reference:​SFobs.txt|SFobs.txt]] with observed snowfall fractions is present and should be used. Give //Y// to use the file, or //N// (default). ​                                                                                                                                                                                                                                                                                                                                                                                                                                                        ​
-|''​readswobs''​|//​Y/​N//​|defines if [[start:​hype_file_reference:​SWobs.txt|SWobs.txt]] with observed shortwave radiation is present and should be used. Give //Y// to use the file, or //N// (default).| +| ''​readswobs'' ​        ​| //​Y/​N// ​            ​| defines if [[start:​hype_file_reference:​SWobs.txt|SWobs.txt]] with observed shortwave radiation is present and should be used. Give //Y// to use the file, or //N// (default). ​                                                                                                                                                                                                                                                                                                                                                                                                                                                       
-|''​readuobs''​|//​Y/​N//​|defines if [[start:​hype_file_reference:​Uobs.txt|Uobs.txt]] with observed wind speeds is present and should be used. Give //Y// to use the file, or //N// (default). Replaces ''​readwind''​.| +| ''​readuobs'' ​         | //​Y/​N// ​            ​| defines if [[start:​hype_file_reference:​Uobs.txt|Uobs.txt]] with observed wind speeds is present and should be used. Give //Y// to use the file, or //N// (default). Replaces ''​readwind''​. ​                                                                                                                                                                                                                                                                                                                                                                                                                                          ​
-|''​readrhobs''​|//​Y/​N//​|defines if [[start:​hype_file_reference:​RHobs.txt|RHobs.txt]] with observed relative humidity is present and should be used. Give //Y// to use the file, or //N// (default). Replaces ''​readhumid''​.| +| ''​readrhobs'' ​        ​| //​Y/​N// ​            ​| defines if [[start:​hype_file_reference:​RHobs.txt|RHobs.txt]] with observed relative humidity is present and should be used. Give //Y// to use the file, or //N// (default). Replaces ''​readhumid''​. ​                                                                                                                                                                                                                                                                                                                                                                                                                                 
-|''​readtminobs''​|//​Y/​N//​|defines if [[start:​hype_file_reference:​TMINobs.txt|TMINobs.txt]] with observed min air temperatures are present and should be used. Give //Y// to use the file, or //N// (default). Replaces ''​readtminmaxobs''​.| +| ''​readtminobs'' ​      ​| //​Y/​N// ​            ​| defines if [[start:​hype_file_reference:​TMINobs.txt|TMINobs.txt]] with observed min air temperatures are present and should be used. Give //Y// to use the file, or //N// (default). Replaces ''​readtminmaxobs''​. ​                                                                                                                                                                                                                                                                                                                                                                                                                    ​
-|''​readtmaxobs''​|//​Y/​N//​|defines if [[start:​hype_file_reference:​TMAXobs.txt|TMAXobs.txt]] with observed max air temperatures are present and should be used. Give //Y// to use the file, or //N// (default). Replaces ''​readtminmaxobs''​.| +| ''​readtmaxobs'' ​      ​| //​Y/​N// ​            ​| defines if [[start:​hype_file_reference:​TMAXobs.txt|TMAXobs.txt]] with observed max air temperatures are present and should be used. Give //Y// to use the file, or //N// (default). Replaces ''​readtminmaxobs''​. ​                                                                                                                                                                                                                                                                                                                                                                                                                    ​
-|''​readxomsfiles''​|//​Y/​N//​|defines if files [[start:​hype_file_reference:​XobsXOMn.txt|XobsXOMn.txt]] and [[start:​hype_file_reference:​XobsXOSn.txt|XobsXOSn.txt]] are present and should be used (n=0-9). Files hold observations of optional, not predefined variables, XOSn are summed over time in output files while XOMn are averaged. Give //Y// to use the file, or //N// (default).| +| ''​readxomsfiles'' ​    ​| //​Y/​N// ​            ​| defines if files [[start:​hype_file_reference:​XobsXOMn.txt|XobsXOMn.txt]] and [[start:​hype_file_reference:​XobsXOSn.txt|XobsXOSn.txt]] are present and should be used (n=0-9). Files hold observations of optional, not predefined variables, XOSn are summed over time in output files while XOMn are averaged. Give //Y// to use the file, or //N// (default). ​                                                                                                                                                                                                                                                                      ​
-|''​submodel''​|//​Y/​N//​|defines if only a part of the model domain is to be simulated. Give //Y// for yes or //N// for no. Default is //N//. The submodel is then defined in the file [[start:​hype_file_reference:​pmsf.txt|pmsf.txt]].| +| ''​submodel'' ​         | //​Y/​N// ​            ​| defines if only a part of the model domain is to be simulated. Give //Y// for yes or //N// for no. Default is //N//. The submodel is then defined in the file [[start:​hype_file_reference:​pmsf.txt|pmsf.txt]]. ​                                                                                                                                                                                                                                                                                                                                                                                                                      ​
-|''​irrrunlimited''​|//​Y/​N//​|defines if irrigation withdrawals should be taken from within the model domain (//N//, default) or from an unlimited outside source (//Y//). For further irrigation details, see [[start:​hype_file_reference:​MgmtData.txt|MgmtData.txt]]| +| ''​irrrunlimited'' ​    ​| //​Y/​N// ​            ​| defines if irrigation withdrawals should be taken from within the model domain (//N//, default) or from an unlimited outside source (//Y//). For further irrigation details, see [[start:​hype_file_reference:​MgmtData.txt|MgmtData.txt]] ​                                                                                                                                                                                                                                                                                                                                                                                            ​
-|''​soiliniwet''​|//​Y/​N//​|initiates soil water to porosity instead of field capacity which is default (//N//). Set //Y// to use porosity.| +| ''​soiliniwet'' ​       | //​Y/​N// ​            ​| initiates soil water to porosity instead of field capacity which is default (//N//). Set //Y// to use porosity. ​                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
-|''​soilstretch''​|//​Y/​N//​|define if parameter //​soilcorr//​ shall be used to stretch the soil depths given by [[start:​hype_file_reference:​geoclass.txt|GeoClass.txt]].| +| ''​soilstretch'' ​      ​| //​Y/​N// ​            ​| define if parameter //​soilcorr//​ shall be used to stretch the soil depths given by [[start:​hype_file_reference:​geoclass.txt|GeoClass.txt]]. ​                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         
-|''​modeloption''​|//​processmodel #//|takes two arguments and defines if an alternative processmodel should be used. Default is 0, alternative processmodels correspond to higher integers. For available processmodels,​ see below.| +| ''​modeloption'' ​      ​| //​processmodel #//  | takes two arguments and defines if an alternative processmodel should be used. Default is 0, alternative processmodels correspond to higher integers. For available processmodels,​ see below. ​                                                                                                                                                                                                                                                                                                                                                                                                                                       
-|''​indatacheckonoff''​|//​0-3//​|defines if setup- and observation files as well as hydrological processes and model options will be checked for formal errors prior to running the model. Default is to not perform any checks (0). 1) Tests will be performed and the simulation will be aborted if errors are found. 2) Tests will be performed and the simulation will be continued regardless if errors are found. 3) Tests will be performed and simulation will be aborted regardless if errors are found or not.| +| ''​indatacheckonoff'' ​ | //​0-3// ​            ​| defines if setup- and observation files as well as hydrological processes and model options will be checked for formal errors prior to running the model. Default is to not perform any checks (0). 1) Tests will be performed and the simulation will be aborted if errors are found. 2) Tests will be performed and the simulation will be continued regardless if errors are found. 3) Tests will be performed and simulation will be aborted regardless if errors are found or not.                                                                                                                                              
-|''​indatachecklevel''​|//​0-2//​|Printout level for verification and validation checks: 0) only passed/​failed,​ 1) also show which tests were performed, 2) also show parameters/​inputs| +| ''​indatachecklevel'' ​ | //​0-2// ​            ​| Printout level for verification and validation checks: 0) only passed/​failed,​ 1) also show which tests were performed, 2) also show parameters/​inputs ​                                                                                                                                                                                                                                                                                                                                                                                                                                                                               
-|''​usestop84''​|//​Y/​N//​|flag to use the old return code 84 for a successful run|+| ''​usestop84'' ​        ​| //​Y/​N// ​            ​| flag to use the old return code 84 for a successful run                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
 </​sortable>​ </​sortable>​
 +
 +
 +===== Model options =====
  
  
Line 142: Line 143:
 |''​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.|+|''​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//.|
start/hype_file_reference/info.txt.1529582230.txt.gz · Last modified: 2018/06/21 13:57 by cpers