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 | ||
|
start:hype_file_reference:info.txt [2023/10/20 09:09] cpers [General] |
start:hype_file_reference:info.txt [2024/02/21 08:47] (current) cpers |
||
|---|---|---|---|
| Line 58: | Line 58: | ||
| | ''parensemble'' | //Y/N// | defines if several simulations with different parameters should be run, default is no. Not to be combined with calibration. | | | ''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 forcing 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. 4 is to be netcdf files (currently under development) | | + | | ''readformat'' | //0/4// | handles several different formats of forcing data. The default (0) is ASCII-files (handles dates in the format yyyy-mm-dd [hh:mm] and as integer ("MATLAB format"). 4 is netcdf files | |
| | ''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. | | ||
| | ''writetimeformat'' | //0/1// | code for writing time to output files besides date (1), default is not (0) except for simulation with shorter time steps | | | ''writetimeformat'' | //0/1// | code for writing time to output files besides date (1), default is not (0) except for simulation with shorter time steps | | ||
| | ''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 time step. 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 [[start:hype_file_reference:ForcKey.txt|ForcKey.txt]] will be used. Give //Y// to read the file (default). Then columns of pobsid/tobsid/etc. present in the file will be used. Set //N// to force the use of subid as connection between forcing data columns and and GeoData. | | | ''readobsid'' | //Y/N// | defines [[start:hype_file_reference:ForcKey.txt|ForcKey.txt]] will be used. Give //Y// to read the file (default). Then columns of pobsid/tobsid/etc. present in the file will be used. Set //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). | | ||
| Line 83: | Line 83: | ||
| | ''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) | | | ''useicecurves'' | //Y/N// | defines if provided ice season river rating curves should be used (default is Y) | | ||
| - | | ''warning'' | //Y/N// | can be used to reduce the number of warning messages in hyss.log (default is Y) | | + | | ''warning'' | //Y/N// | can be turned off to reduce the number of warning messages in hyss.log (default is Y) | |
| </sortable> | </sortable> | ||
| Line 99: | Line 99: | ||
| |''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]]).| | ||
| |''diffusesource''|//0/1//|defines how rural household diffuse source should be added to the soil. (0) as a flow (the locsoil part) with concentration, (1) as a load. See [[start:hype_file_reference:GeoData.txt|GeoData.txt]]| | |''diffusesource''|//0/1//|defines how rural household diffuse source should be added to the soil. (0) as a flow (the locsoil part) with concentration, (1) as a load. See [[start:hype_file_reference:GeoData.txt|GeoData.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.| | + | |''erosionmodel''|//0/1//|defines which soil erosion model to be used for simulation of sediments and phosphorus. Default (0) is based on MMF , 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'.| | |''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).| | |''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/2/3/4//|defines if varying start of the growth season should be used. Default (0) is no variation, then [[start:hype_file_reference:CropData.txt|CropData.txt]] constant parameter //bd2// is used for nutrient uptake and plantday for irrigation. The alternatives are (1) to used varying growth season start (degree day method) for nutrient uptake, (2) to use varying growth season (degree day method) start for irrigation but not for nutrient uptake, (3) to use varying growth season start (degree day method) for irrigation and nutrient uptake, and (4) use varying growth season start (temperature threshold method) for irrigation and nutrient uptake. For all methods the season start is calculated based on 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.| | |''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.| | ||
| Line 114: | Line 114: | ||
| |''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). (3) snowfall distribution between subbasin as well as within (loglin WSF).| | + | |''snowfalldist''|//0/1/2/3/4//|defines which snowfall distribution model to use. Default is none (0), alternatives are scaling using linear (1) or log-linear (2) equation with Winstrals coefficients (WSF). (3) snowfall distribution to nearest downwind subbasin as well as within the subbasin (log-lin WSF). (4) snowfall distribution between subbasins within a distance range (log-lin 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'.| | |''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'.| | ||
| Line 126: | Line 126: | ||
| ===== Output options ===== | ===== Output options ===== | ||
| - | HYPE offers in prinicple three output types for standard model runs, as well as some variants, all of which are formatted text files with tabular content which is controlled with code combinations in info.txt. Additional output are two types of files which are activated by single codes, and time series in netcdf format are being developed: | + | HYPE offers in principle three output types for standard model runs, as well as some variants, all of which are formatted text files with tabular content which is controlled with code combinations in info.txt. Additional output are two types of files which are activated by single codes, and time series output in netcdf format: |
| * **basin outputs**, which return multiple variables for a single subcatchment in one file [[start:hype_file_reference:XXXXXXX.txt|XXXXXXX.txt]] per subcatchment, where 'XXXXXXX' is the ID of the subcatchment, a number with maximum 7 digits (filled with leading zeros in case of shorter ID, e.g. //0001234.txt//). | * **basin outputs**, which return multiple variables for a single subcatchment in one file [[start:hype_file_reference:XXXXXXX.txt|XXXXXXX.txt]] per subcatchment, where 'XXXXXXX' is the ID of the subcatchment, a number with maximum 7 digits (filled with leading zeros in case of shorter ID, e.g. //0001234.txt//). | ||
| * **region outputs**, similar to basin outputs (return multiple variables for a single region in one file) [[start:hype_file_reference:XXXXXXX.txt(regional)|XXXXXXX.txt]], where 'XXXXXXX' is the ID of the output region (must not overlap subids). | * **region outputs**, similar to basin outputs (return multiple variables for a single region in one file) [[start:hype_file_reference:XXXXXXX.txt(regional)|XXXXXXX.txt]], where 'XXXXXXX' is the ID of the output region (must not overlap subids). | ||
| Line 136: | Line 136: | ||
| * **netcdf outputs**, similar to time output it return single variables for all sub-catchments in one file [[start:hype_file_reference:timeXXXX.nc|timeXXXX.nc]] per variable, where 'XXXX' is the four-letter variable ID, e.g. //timeCOUT.nc//. | * **netcdf outputs**, similar to time output it return single variables for all sub-catchments in one file [[start:hype_file_reference:timeXXXX.nc|timeXXXX.nc]] per variable, where 'XXXX' is the four-letter variable ID, e.g. //timeCOUT.nc//. | ||
| - | 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 optional. |
| - | 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. | + | 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 for a simulation 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. | 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. | ||
| + | It is possible to add global attributes to netcdf output files. The attributes are specified here in info.txt and all files gets the same attributes. Maximum 50 user specified attributes may be given. | ||
| Line 158: | Line 159: | ||
| | ''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//. | | ||
| + | | ''ncfileatt'' | //name of attribute// | //value of attribute// | defines a global attribute for ''netcdfoutput'' files. A maximum of 50 attributes may be given, one per row. The //name of attribute// is a string of less than 50 characters (no blank). The //value of attribute// is a string of maximum 500 characthers enclosed in apostrophes. | | ||
| </sortable> | </sortable> | ||
| Line 196: | Line 198: | ||
| <sortable> | <sortable> | ||
| ^ Code_1 ^ Code 2 ^ Argument ^ Description ^ | ^ Code_1 ^ Code 2 ^ Argument ^ Description ^ | ||
| - | |''crit''|''meanperiod''|//1/2/3/4//|defines the period over which the data will be accumulated (i.e. no weighting on volume for concentrations) before calculating the performance criterion, i.e. criterion will be calculated from daily, weekly, monthly or annual values. 1-daily, 2-weekly, 3-monthly, 4-annually. Default is daily.| | + | |''crit''|''meanperiod''|//0/1/2/3/4//|defines the period over which the data will be accumulated (i.e. no weighting on volume for concentrations) before calculating the performance criterion, i.e. criterion will be calculated from daily, weekly, monthly or annual values. 0-simulation time step, 1-daily, 2-weekly, 3-monthly, 4-annually. Default is daily.| |
| |''crit''|''subassmodel''|//0/1/2//|defines if and which subbasin assessment to write. 0-none, 1-default, 2-extra information. Default is 1.| | |''crit''|''subassmodel''|//0/1/2//|defines if and which subbasin assessment to write. 0-none, 1-default, 2-extra information. Default is 1.| | ||
| |''crit''|''subassform''|//0/1//|defines format of subbasin assessment values. 0- with 4 decimals (default), 1- in scientific format.| | |''crit''|''subassform''|//0/1//|defines format of subbasin assessment values. 0- with 4 decimals (default), 1- in scientific format.| | ||
| Line 207: | Line 209: | ||
| |''crit n''|''parameter''|//numeric//|parameter value used for RA-criteria coefficient value. See coefficient ''a'' in [[start:hype_file_reference:info.txt:criteria_equations#criteria_equations_for_a_time_series_of_a_station| RA equation definition]].| | |''crit n''|''parameter''|//numeric//|parameter value used for RA-criteria coefficient value. See coefficient ''a'' in [[start:hype_file_reference:info.txt:criteria_equations#criteria_equations_for_a_time_series_of_a_station| RA equation definition]].| | ||
| |''crit n''|''conditional''|//numeric//|parameter value. Only used for DEMC-calibration. The parameter value is the threshold for the criterion.| | |''crit n''|''conditional''|//numeric//|parameter value. Only used for DEMC-calibration. The parameter value is the threshold for the criterion.| | ||
| - | |''crit n''|''cgroup''|//name//|name of the classgroup for which the simulated variable to calculate criterion with is to be taken. Note observed variables can not be specified on classgroup level. Suitable variable can be defined as e.g. xom1.| | + | |''crit n''|''cgroup''|//name//|name of the classgroup for which the simulated and recorded variable represent.| |
| + | |''crit n''|''cgroupcomp''|//name//|name of the classgroup for which the simulated variable represent. The observed variables is specified separately.| | ||
| + | |''crit n''|''cgrouprec''|//name//|name of the classgroup for which the recorded variable represent. Note that if cgrouprec (or cgroup) is not given the basinwide variable will be used. In this cas, suitable variable can be defined as e.g. xom1.| | ||
| </sortable> | </sortable> | ||
start/hype_file_reference/info.txt.1697785781.txt.gz · Last modified: 2023/11/16 14:28 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
