User Tools

Site Tools


start:hype_file_reference:branchdata.txt

Differences

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

Link to this comparison view

Next revision
Previous revision
start:hype_file_reference:branchdata.txt [2015/03/26 13:52]
rcapell created
start:hype_file_reference:branchdata.txt [2021/06/15 15:26]
cpers
Line 1: Line 1:
 ====== BranchData.txt ====== ====== BranchData.txt ======
  
-This tab separated ​file includes information about all bifurcations. ​The file is located in the modeldir folder. +This file contains ​all bifurcations ​within a HYPE model domainBifurcations are stream splits in downstream direction. They can occur naturally, but are often used in HYPE to describe inter-catchment water transfers for e.g. hydropower production. HYPE allows to split water flows by fixed fractions (''​mainpart''​) and optionally to define minimum and maximum flow limits. Another way to determine branch flow is through lakes with two outlets defined in [[start:​hype_file_reference:​lakedata.txt|LakeData.txt]]. Then only the path of the branch is necessary to give in BranchData.txt,​ but ''​mainpart''​ can also be given. It is used to calculate the upstream area of the subbasin, which in turn is used for calculating initial volume of main river, general rating curve parameters, upstream-area-output variables etc. A third way to define branch flow is by prescribing a constant or a time series of the wanted flow.  
-The first row contains column ​headingsThese may be maximum ​10 characters ​long and may not include ​spaces. ​They are read in by the program which then matches the column’s ​data with the correct variable. +  
-The column headings ​may be upper- or lower-case lettersNote that a value must exist for every column and row, i.e. no empty cells allowed. ​Columns whose headings do not match variable ​in the model may exist but are not readText columns may exist but have maximum 50 lettersColumns may be in any order.+ 
 +//​BranchData.txt//​ is a tab-separated file located in the [[start:​hype_file_reference:​info.txt&#​model_options|modeldir]] folder. ​Sub-basins with bifurcations are listed row-wise. ​The first row contains ​column ​header with variable names. Variable names are not case-sensitive (max. 10 characters, no spaces)Columns with headings unknown to HYPE are skipped while reading ​the file, but must not longer than ten characters. Columns containing character strings, e.g. descriptive meta-data, must not exceed a length of 100 characters. The columns ​may be in any ordervalue must exist for every column and row, i.e. empty cells are not allowed. ​ 
 + 
 +Example for //​BranchData.txt//​ file structure with two bifurcations:​ 
 + 
 +  name         ​sourceid branchid mainpart maxqmain minqmain maxqbranch 
 +  bifurcation1 43       ​576 ​     0.9      5000     ​350 ​     1 
 +  bifurcation2 3955     ​2301 ​    ​0.5 ​     0        0        500 
 + 
 + 
 +The table below describes all //​BranchData.txt//​ columns read by HYPE. 
 + 
 +/** 
 + * ____________IMPORTANT!__________IMPORTANT!________________IMPORTANT!_______________________IMPORTANT!______________ 
 + * 
 + * The table below is maintained in spreadsheed file '​file_reference_tables.xlsx'​ 
 + ​* ​in the wiki back-up folder on our server. 
 + * Please edit table contents there and then copy-paste the updated full table to this pageAsk René if something is  
 + * unclear. Thanks. 
 + * ___________________________________________________________________________________________________________________ 
 + */ 
 + 
 +<​sortable>​ 
 +^ Variable ID     ^ Unit                 ^ Description ​                                                                                                                                                                                       ^ 
 +| ''​sourceid'' ​   | //-//                | SUBID of sub-basin with bifurcation,​ i.e. with two downstream sub-basins ​                                                                                                                          | 
 +| ''​branchid'' ​   | //-//                | SUBID of sub-basin receiving the second branch flow, must be located ​in a row below the sub-basin with bifurcation in [[start:​hype_file_reference:​geodata.txt|GeoData.txt]] ​                       | 
 +| ''​mainpart'' ​   | //-//                | fraction of flow from subbasin sourceid that flows in the main branch (as given in column //​maindown//​ in [[start:​hype_file_reference:​geodata.txt|GeoData.txt]]) (between 0 and 1). Default is 1.  | 
 +| ''​maxQmain'' ​   | //​m<​sup>​3</​sup>/​s// ​ | maximum flow that is allowed in the main branch. Use 0 for no limitation or exclude column completely. ​                                                                                            | 
 +| ''​minQmain'' ​   | //​m<​sup>​3</​sup>/​s// ​ | minimum flow that is required in the main branch before water is routed into branch. Use 0 for no limitation or exclude column completely. ​                                                        | 
 +| ''​maxQbranch'' ​ | //​m<​sup>​3</​sup>/​s// ​ | maximum flow that is allowed in the branch. Use 0 for no limitation or exclude column completely. ​                                                                                                 | 
 +| ''​Qbranch'' ​    | //-//                | the flow of the branch is prescribed; 0 (default) not use, 1 read flow from Xobs.txt (''​dwtr''​) ​                                                                                                       | 
 +</​sortable>​
start/hype_file_reference/branchdata.txt.txt · Last modified: 2021/06/15 15:26 by cpers