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
Next revision Both sides next revision
start:hype_file_reference:info.txt [2019/09/13 11:17]
cpers [Output options]
start:hype_file_reference:info.txt [2020/04/29 11: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 datesmay 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. ​                                                                                                                                                                                                                              | 
 +| ''​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 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 91: Line 94:
 ^  Code 2  ^  Argument ​ ^  Description ​ ^ ^  Code 2  ^  Argument ​ ^  Description ​ ^
 |''​deepground''​|//​0/​1/​2//​|defines which model to use for regional groundwater flow and aquifers. Default is none (0), alternative is a regional groundwater flow model without dedicated aquifer volumes (subsurface transfer between subcatchments) (1) and an aquifer model with dedicated regional aquifer volumes (2) (requires aquifer definition in input file [[start:​hype_file_reference:​AquiferData.txt|AquiferData.txt]]).| |''​deepground''​|//​0/​1/​2//​|defines which model to use for regional groundwater flow and aquifers. Default is none (0), alternative is a regional groundwater flow model without dedicated aquifer volumes (subsurface transfer between subcatchments) (1) and an aquifer model with dedicated regional aquifer volumes (2) (requires aquifer definition in input file [[start:​hype_file_reference:​AquiferData.txt|AquiferData.txt]]).|
 +|''​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.|
 |''​floodmodel''​|//​0/​1/​2/​3//​|defines which model to use for floodplains. Default is none (0), alternatives are a simple model (1) and a model with soilroutines (2). A fourth option (3) is to use the model with soil routines and connecting floodplains. All requires floodplain information in input file [[start:​hype_file_reference:​FloodData.txt|FloodData.txt]]).| |''​floodmodel''​|//​0/​1/​2/​3//​|defines which model to use for floodplains. Default is none (0), alternatives are a simple model (1) and a model with soilroutines (2). A fourth option (3) is to use the model with soil routines and connecting floodplains. All requires floodplain information in input file [[start:​hype_file_reference:​FloodData.txt|FloodData.txt]]).|
 +|''​frozensoil''​|//​0/​1/​2//​|defines which frozen soil model to use. Default is none (0), the alternatives calculates frozen volume as a function of temperature with (1) one temperature per soil layer (2) temperature distribution within soil layer. Frozen soil model uses parameters '​logsatmp',​ '​bcosby'​ and '​fzsexpand'​.|
 +|''​glacierini''​|//​0/​1//​|defines if initialization from SLC+parameters overrides saved state of glacier volume (1). Default is to use saved state (0).|
 |''​growthstartmodel''​|//​0/​1//​|defines if temperature varying start of the growth season should be used. Default is 0, then [[start:​hype_file_reference:​CropData.txt|CropData.txt]] constant parameter bd2 is used. The alternative is 1, i.e. to used varying growth season start. Then the season start is calculated based on degreedays (equation defined by parameters in [[start:​hype_file_reference:​CropData.txt|CropData.txt]]).| |''​growthstartmodel''​|//​0/​1//​|defines if temperature varying start of the growth season should be used. Default is 0, then [[start:​hype_file_reference:​CropData.txt|CropData.txt]] constant parameter bd2 is used. The alternative is 1, i.e. to used varying growth season start. Then the season start is calculated based on degreedays (equation defined by parameters in [[start:​hype_file_reference:​CropData.txt|CropData.txt]]).|
 +|''​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.|
 |''​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).|
 |''​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]].|
 +|''​snowfalldist''​|//​0/​1/​2//​|defines which snowfall distribution model to use. Default is none (0), alternatives are scaling using linear (1) or log-linear (2) Winstrals coefficients (WSF).|
 |''​snowfallmodel''​|//​0/​1//​|defines if an alternative snowfall model should be used. Default is threshold temperature (0), alternative is snowfall fraction from [[start:​hype_file_reference:​SFobs.txt|SFobs.txt]] (1).| |''​snowfallmodel''​|//​0/​1//​|defines if an alternative snowfall model should be used. Default is threshold temperature (0), alternative is snowfall fraction from [[start:​hype_file_reference:​SFobs.txt|SFobs.txt]] (1).|
 +|''​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.|
 |''​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.|
-|''​glacierini''​|//​0/​1//​|defines if initialization from SLC+parameters overrides saved state of glacier volume (1). Default is to use saved state (0).| 
-|''​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.| 
 |''​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.|
-|''​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 134: Line 140:
  
 <​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, 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. \\ **Note:** //​signfigures//​ applies to all output variables within one output type. If set, significant figures and mathematical format are used (e.g 9.5451E-03) instead. 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>​
  
start/hype_file_reference/info.txt.txt · Last modified: 2024/02/21 08:47 by cpers