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 [2019/09/13 11:17]
cpers [Output options]
start:hype_file_reference:info.txt [2019/10/25 10:54] (current)
cpers [Table]
Line 134: Line 134:
  
 <​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.1568366235.txt.gz · Last modified: 2019/09/13 11:17 by cpers