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 [2020/12/02 07:37] cpers [General] |
start:hype_file_reference:info.txt [2021/09/15 15:31] cpers [Model options] |
||
|---|---|---|---|
| Line 12: | Line 12: | ||
| Comment rows can be added anywhere and are marked with double exclamation marks, i.e. !!, or '!!' followed by a space. For other rows, the first (and sometimes second) code string decides what information is to be read. The code can be written within or without apostrophes ('…'). Most codes are optional and can be omitted if not required in a model run. Codes are not case sensitive, except for directory paths given after codes //modeldir//, //forcingdir// and //resultdir//, and time steps given after code //steplength//. Date-times are always specified as the beginning of the timestep. Maximum 18000 characters can be read on a single line. | Comment rows can be added anywhere and are marked with double exclamation marks, i.e. !!, or '!!' followed by a space. For other rows, the first (and sometimes second) code string decides what information is to be read. The code can be written within or without apostrophes ('…'). Most codes are optional and can be omitted if not required in a model run. Codes are not case sensitive, except for directory paths given after codes //modeldir//, //forcingdir// and //resultdir//, and time steps given after code //steplength//. Date-times are always specified as the beginning of the timestep. Maximum 18000 characters can be read on a single line. | ||
| - | A typical info file contains four groups of code-argument combinations: | + | A typical info file contains five groups of code-argument combinations: |
| + | - Simulation options, e.g. simulation time period, where to find the model set-up | ||
| - Model options, e.g. specification of time stepping, choice of optional modules, etc. | - Model options, e.g. specification of time stepping, choice of optional modules, etc. | ||
| - Output options, i.e. type of result files and output variable specification | - Output options, i.e. type of result files and output variable specification | ||
| Line 38: | Line 39: | ||
| | ''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 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. | | | ''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. | | ||
| + | | ''instatecompress'' | //Y/N// | defines whether the starting state is an compressed file or not. Y for yes, N for no. No is default. The filename of the compressed file is the same as for the ASCII-text state file, but with different file ending (state_saveyyyymmdd[HHMM].tgz). | | ||
| + | | ''outstatecompress'' | //Y/N// | defines whether the created outstate files are to be compressed and the text file then deleted. Y for yes, N for no. No is default. The filename of the compressed file is the same as for the ASCII-text state file, but with different file ending (state_saveyyyymmdd[HHMM].tgz). | | ||
| | ''resetstatedate'' | //date-time// | defines that nutrient soil states will be reset to the starting state. The date should be in the format yyyy-mm-dd [HH:MM]. The default is that no reset is done. Maximum 100 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 reset starting state is saved in file [[start:hype_file_reference:reset_state_save|reset_state_save.txt]]. | | | ''resetstatedate'' | //date-time// | defines that nutrient soil states will be reset to the starting state. The date should be in the format yyyy-mm-dd [HH:MM]. The default is that no reset is done. Maximum 100 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 reset starting state is saved in file [[start:hype_file_reference:reset_state_save|reset_state_save.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 Si T1 T2//. N - nitrogen, P - phosphorus, C - organic carbon, S - total suspended sediment, Si - silica, 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 soilcorr. | | | ''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 soilcorr. | | ||
| + | | ''weightsub'' | //Y/N// | defines if the objective function and performance criteria should be weighted by a given trust in each subcatchment (only for criteria that are average of subbasins). Default is no. | | ||
| + | | ''parensemble'' | //Y/N// | defines if several simulations with different parameters should be run, default is no. Not to be combined with calibration. | | ||
| | ''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 | | ||
| Line 64: | Line 69: | ||
| | ''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 | | ||
| + | | ''useicecurves'' | //Y/N// | defines if provided ice season river rating curves should be used (default is Y) | | ||
| </sortable> | </sortable> | ||
| Line 85: | Line 91: | ||
| |''lakeriverice''|//0/1/2//|defines if ice on lakes and rivers should be simulated. Default is no (0), while a positive number means yes. The alternative models are (1) with temperature transfer between air and water and (2) with water surface heat balance. The ice calculations require that //substance// T2 (water temperature) is simulated.| | |''lakeriverice''|//0/1/2//|defines if ice on lakes and rivers should be simulated. Default is no (0), while a positive number means yes. The alternative models are (1) with temperature transfer between air and water and (2) with water surface heat balance. The ice calculations require that //substance// T2 (water temperature) is simulated.| | ||
| |''petmodel''|//0/1/2/3/4/5//|defines if an alternative potential evapotranspiration model should be used. Default is temperature dependence or use of observations (0), alternatives are temperature dependent (1), modified Jensen-Haise/McGuinness (2), modified Hargreaves-Samani (3), Priestly-Taylor (4), and FAO Penman-Monteith reference crop evapotranspiration (5).| | |''petmodel''|//0/1/2/3/4/5//|defines if an alternative potential evapotranspiration model should be used. Default is temperature dependence or use of observations (0), alternatives are temperature dependent (1), modified Jensen-Haise/McGuinness (2), modified Hargreaves-Samani (3), Priestly-Taylor (4), and FAO Penman-Monteith reference crop evapotranspiration (5).| | ||
| + | |''sedresuspmodel''|//0/1/2//|define which model to use for river sedimentation/resuspension. Default is (0) the original HYPE method, the alternatives (1) is flow dependent method with parameter and (2) is a simplified Bagnold Equation.| | ||
| |''snowdensity''|//0/1//|defines which snowdensity model to use. Default is snow age dependent snowdensity (0), and alternative is snow compactation snow density model (1).| | |''snowdensity''|//0/1//|defines which snowdensity model to use. Default is snow age dependent snowdensity (0), and alternative is snow compactation snow density model (1).| | ||
| |''snowevaporation''|//0/1//|defines if evaporation (sublimation) from snow and glaciers should be calculated. Default is off (0), and alternative is on (1). Snow and glacier evaporation is governed by the general parameters ‘fepotsnow’, ‘fepotglac’, and ‘fsceff’ in [[start:hype_file_reference:par.txt|par.txt]].| | |''snowevaporation''|//0/1//|defines if evaporation (sublimation) from snow and glaciers should be calculated. Default is off (0), and alternative is on (1). Snow and glacier evaporation is governed by the general parameters ‘fepotsnow’, ‘fepotglac’, and ‘fsceff’ in [[start:hype_file_reference:par.txt|par.txt]].| | ||
| Line 91: | Line 98: | ||
| |''snowheat''|//0/1//|defines if snow heat shall be calculated and used to limit snow melt. Default is no (0), and alternative is yes (1). Snow heat model uses parameters 'sdnsnew' and 'snkika'.| | |''snowheat''|//0/1//|defines if snow heat shall be calculated and used to limit snow melt. Default is no (0), and alternative is yes (1). Snow heat model uses parameters 'sdnsnew' and 'snkika'.| | ||
| |''snowmeltmodel''|//0/2//|defines which snowmelt model should be used. Default is temperature index (0), the alternative is temperature and radiation index (2). Previous option (1) temperature index with snowcover scaling is no longer used. Snowcover scaling of melt and evaporation is controlled by parameter ‘fsceff’, see section [[start:hype_file_reference:par.txt|par.txt]].| | |''snowmeltmodel''|//0/2//|defines which snowmelt model should be used. Default is temperature index (0), the alternative is temperature and radiation index (2). Previous option (1) temperature index with snowcover scaling is no longer used. Snowcover scaling of melt and evaporation is controlled by parameter ‘fsceff’, see section [[start:hype_file_reference:par.txt|par.txt]].| | ||
| - | |''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/2/3//|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, (2) defines that class specific soil leakage typical monthly loads are to be read from files, (3) defines that class specific soil leakage monthly time-series of loads are to be read from files.| |
| + | |''surfacerunoff''|//0/1/2/3/4//|defines which model to use for diversion of surface runoff and macropore flow from infiltration. Default (0) uses runoff coefficients and soil water threshold, (1) calculates surface runoff from a soil moisture, (2) calculates surface runoff from a soil moisture and rain, (3) is same as (1) but with a discrete formulation of the equation, (4) is same as (2) but with a discrete formulation of the equation.| | ||
| |''swtemperature''|//0/1//|defines if T2 temperature should be used for WQ-processes in surface waters. Default is not (0), alternative is (1). The calculations require that //substance// T2 is simulated.| | |''swtemperature''|//0/1//|defines if T2 temperature should be used for WQ-processes in surface waters. Default is not (0), alternative is (1). The calculations require that //substance// T2 is simulated.| | ||
| |''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.| | |''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.| | ||
| Line 109: | Line 117: | ||
| 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. | 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 aggregation periods for the same type of output (basin- , class-, 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. | + | Output can be given for each time step or aggregated to longer periods. This is specified by the code ''meanperiod''. For available aggregation periods see table [[info.txt#aggregation_period_codes|below]]. The aggregation works best if it is in alignment with the simulation and output start date, e.g. yearly output that start 1 January. |
| + | |||
| + | It is possible to get output for several different aggregation periods for the same type of output (basin- , class-, region- or time-output) by specifying several groups of the same type of output with an 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. Note that the ordinal number need to begin at 1 and go up, no gaps allowed. | ||
| Line 130: | Line 140: | ||
| === Aggregation period codes === | === Aggregation period codes === | ||
| - | Aggregation period codes (used for ''meanperiod'') and corresponding file name suffix. Simulation period (''5'') aggregates are means of annual aggregates. | + | The table below shows aggregation period codes (used for ''meanperiod'') and corresponding file name suffix. Simulation period (''5'') aggregates are means of annual aggregates. |
| ^ Code ^ Suffix ^ Description ^ | ^ Code ^ Suffix ^ Description ^ | ||
| Line 158: | Line 168: | ||
| HYPE can calculate several performance criteria over the model domain. HYPE allows to set several criteria which evaluate the whole model domain, e.g. an average Nash-Sutcliffe efficiency over all stations. If several of these domain-wide criteria are set in the performance criteria options they will be added, optionally with weights, to give an overall performance measure. This measure will be used as objective function in the calibration routines. Performance measure and domain-wide criteria are written to output file [[start:hype_file_reference:simass.txt|simass.txt]]. Users can also access all criteria values for each subbasin (observation site at catchment outlet) seperately in output file [[start:hype_file_reference:subassx.txt|subassX.txt]]. Criteria are calculated for all subbasins where observation data are available. Criteria are always based on the model evaluation period as defined with codes ''cdate'' and ''edate'', see [[start:hype_file_reference:info.txt&#model_options|Model options]]. | HYPE can calculate several performance criteria over the model domain. HYPE allows to set several criteria which evaluate the whole model domain, e.g. an average Nash-Sutcliffe efficiency over all stations. If several of these domain-wide criteria are set in the performance criteria options they will be added, optionally with weights, to give an overall performance measure. This measure will be used as objective function in the calibration routines. Performance measure and domain-wide criteria are written to output file [[start:hype_file_reference:simass.txt|simass.txt]]. Users can also access all criteria values for each subbasin (observation site at catchment outlet) seperately in output file [[start:hype_file_reference:subassx.txt|subassX.txt]]. Criteria are calculated for all subbasins where observation data are available. Criteria are always based on the model evaluation period as defined with codes ''cdate'' and ''edate'', see [[start:hype_file_reference:info.txt&#model_options|Model options]]. | ||
| - | Performance criteria are specified in //info.txt// with code ''crit'' or ''crit n'', followed by a second code. ''n'' is used to number individual domain-wide performance criteria which are combined to the overall performance measure as described above. Up to 100 criteria are allowed, [[start:hype_file_reference:info.txt:criteria|a complete list of available criteria is available]] as are [[start:hype_file_reference:info.txt:criteria_equations| equation definitions]]. Calibration routines require further settings in additional input files, see [[start:hype_file_reference&#calibration_files|Calibration files]]. | + | Performance criteria are specified in //info.txt// with code ''crit'' or ''crit n'', followed by a second code. ''n'' is used to number individual domain-wide performance criteria which are combined to the overall performance measure as described above. Up to 100 criteria are allowed, [[start:hype_file_reference:info.txt:criteria|a complete list of available criteria is available]] as are [[start:hype_file_reference:info.txt:criteria_equations| equation definitions]]. Criterion that is the average of criteria for subbasins may be calculated in two variants; arithmetric mean or weighted average. This is set in info.txt by the code ''weightsub'' (se above). Calibration routines require further settings in additional input files, see [[start:hype_file_reference&#calibration_files|Calibration files]]. |
| For the calculation of criterion for lake water stage, the combination of variables ''wcom'' and ''wstr'' are exchanged for the internal variables ''clwc'' and ''clws'' by the program. These variables are the water stages cleaned from ''w0ref'' reference level (''clwc''= ''wcom''-''w0ref'', ''clws''=''wstr''-''w0ref''). This makes the criterion calculation more accurate, but note that relative criteria, e.g. relative bias, are now relative to the smaller cleaned water stage level. | For the calculation of criterion for lake water stage, the combination of variables ''wcom'' and ''wstr'' are exchanged for the internal variables ''clwc'' and ''clws'' by the program. These variables are the water stages cleaned from ''w0ref'' reference level (''clwc''= ''wcom''-''w0ref'', ''clws''=''wstr''-''w0ref''). This makes the criterion calculation more accurate, but note that relative criteria, e.g. relative bias, are now relative to the smaller cleaned water stage level. | ||
| Line 193: | Line 203: | ||
| ===== Updating options ===== | ===== Updating options ===== | ||
| - | HYPE allows updating of simulated discharge and lake water level with observations during model run as well as updating of nitrogen and phosphorus concentrations using correction factors in individual subbasins. Discharge can be updated directly by discharge observations, by previously saved errors of simulated discharge, or previously saved errors of simulated lake water level. An auto-regressive (AR) model is used to model the errors for the last two methods. Lake water level can be updated by water level observations, or by previously saved errors of simulated lake water level. | + | HYPE allows updating of simulated discharge and lake water level with observations during model run as well as updating of nitrogen and phosphorus concentrations using correction factors or observations in individual subbasins. Discharge can be updated by discharge or water level observations by various methods. Lake water level can be updated by water level observations. |
| - | The updating methods are described in detail in the [[http://www.smhi.net/hype/wiki/doku.php?id=start:hype_tutorials:updating|tutorial]]. Some updating routines require further settings in additional input file [[start:hype_file_reference:update.txt|update.txt]]. | + | The updating methods are described in the [[http://www.smhi.net/hype/wiki/doku.php?id=start:hype_tutorials:updating|tutorial]]. Some updating routines require further settings in an additional input file [[start:hype_file_reference:update.txt|update.txt]]. |
| Line 202: | Line 212: | ||
| |''update''|''quseobs''|//none/keyword//|updating of Q. Thereafter may follow one of the two keywords: 'allstation' for updating using all Q-stations in [[start:hype_file_reference:qobs.txt|Qobs.txt]] or 'nostation' for no updating. If no keyword is given stations given in file [[start:hype_file_reference:update.txt|update.txt]] is updated.| | |''update''|''quseobs''|//none/keyword//|updating of Q. Thereafter may follow one of the two keywords: 'allstation' for updating using all Q-stations in [[start:hype_file_reference:qobs.txt|Qobs.txt]] or 'nostation' for no updating. If no keyword is given stations given in file [[start:hype_file_reference:update.txt|update.txt]] is updated.| | ||
| |''update''|''qar''|//none/keyword//|AR updating of Q on days without observed Q. Uses the switch(1/0) on column ‘qarupd’ in [[start:hype_file_reference:update.txt|update.txt]] for on/off on individual stations. Can be followed by keyword 'nostation' for no AR updating.| | |''update''|''qar''|//none/keyword//|AR updating of Q on days without observed Q. Uses the switch(1/0) on column ‘qarupd’ in [[start:hype_file_reference:update.txt|update.txt]] for on/off on individual stations. Can be followed by keyword 'nostation' for no AR updating.| | ||
| + | |''update''|''wendupd wstr''|//none/keyword//|updating of lake water levels from W observations. Thereafter there may follow one of the two keywords: 'allstation' for updating using all W-stations in [[start:hype_file_reference:xobs.txt|Xobs.txt]] or 'nostation' for no updating.| | ||
| + | |''update''|''war wstr''|//none/keyword//|AR updating of lake water level used to calculate Q. The lake water state variable is not updated. Uses the switch(1/0) on column ‘warupd’ in [[start:hype_file_reference:update.txt|update.txt]] for on/off on individual stations. Can be followed by keyword 'nostation' for no AR updating| | ||
| + | |''update''|''cuseobs''|//none/keyword//|updating of all concentrations. Thereafter may follow one of the two keywords: 'allstation' for updating using all stations in [[start:hype_file_reference:xobs.txt|Xobs.txt]] or 'nostation' for no updating. If no keyword is given stations given in file [[start:hype_file_reference:update.txt|update.txt]] is updated.| | ||
| |''update''|''tpcorr''|//none//|updating of total phosphorus. No further keywords may be given. Which stations and how much is given in file [[start:hype_file_reference:update.txt|update.txt]].| | |''update''|''tpcorr''|//none//|updating of total phosphorus. No further keywords may be given. Which stations and how much is given in file [[start:hype_file_reference:update.txt|update.txt]].| | ||
| |''update''|''tploccorr''|//none//|updating of local phosphorus. No further keywords may be given. Which stations and how much is given in file [[start:hype_file_reference:update.txt|update.txt]].| | |''update''|''tploccorr''|//none//|updating of local phosphorus. No further keywords may be given. Which stations and how much is given in file [[start:hype_file_reference:update.txt|update.txt]].| | ||
| |''update''|''tncorr''|//none//|updating of total nitrogen. No further keywords may be given. Which stations and how much is given in file [[start:hype_file_reference:update.txt|update.txt]].| | |''update''|''tncorr''|//none//|updating of total nitrogen. No further keywords may be given. Which stations and how much is given in file [[start:hype_file_reference:update.txt|update.txt]].| | ||
| |''update''|''tnloccorr''|//none//|updating of local nitrogen. No further keywords may be given. Which stations and how much is given in file [[start:hype_file_reference:update.txt|update.txt]].| | |''update''|''tnloccorr''|//none//|updating of local nitrogen. No further keywords may be given. Which stations and how much is given in file [[start:hype_file_reference:update.txt|update.txt]].| | ||
| - | |''update''|''wendupd wstr''|//none/keyword//|updating of lake water levels from W observations. Thereafter there may follow one of the two keywords: 'allstation' for updating using all W-stations in [[start:hype_file_reference:xobs.txt|Xobs.txt]] or 'nostation' for no updating.| | ||
| - | |''update''|''war wstr''|//none/keyword//|AR updating of lake water level used to calculate Q. The lake water state variable is not updated. Uses the switch(1/0) on column ‘warupd’ in [[start:hype_file_reference:update.txt|update.txt]] for on/off on individual stations. Can be followed by keyword 'nostation' for no AR updating| | ||
| </sortable> | </sortable> | ||
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
