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 [2016/07/08 13:11] cpers [Tutorials on the wiki] |
start [2018/08/06 16:08] cpers [Table] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== The HYPE wiki pages ====== | ====== The HYPE wiki pages ====== | ||
- | \\ | ||
- | \\ | ||
- | \\ | ||
- | **Welcome to the HYPE wiki pages. HYPE is an open source dynamic integrated rainfall-runoff and nutrient transfer model developed and maintained by the Swedish Meteorological and Hydrological Institute (SMHI). //HYPE// is short for //HY//drological //P//redictions for the //E//nvironment. This wiki provides documentation for the HYPE model.** | ||
+ | **Welcome to the HYPE wiki pages. HYPE is an open source dynamic integrated rainfall-runoff and nutrient transfer model developed and maintained by the Swedish Meteorological and Hydrological Institute (SMHI). ** | ||
+ | //HYPE// is short for //HY//drological //P//redictions for the //E//nvironment. This wiki provides documentation for the HYPE model. | ||
- | ===== Documentation ===== | ||
- | [[start:Hype model description| HYPE model description]] on the wiki | ||
- | [[start:HYPE_file_reference|HYPE file reference]] on the wiki | + | ===== Available documentation ===== |
- | |{{:HHcode_structure_simple.png?100|code}}|[[http://sourceforge.net/projects/hype/files/latest_docs/HYSS_HYPE_code_overview.pdf/download|The structure of the HYPE code.]] Download pdf-file with an overview of both HYSS and HYPE code structure.| | + | [[start:Hype model description| HYPE model description]] on this wiki. As exported [[http://sourceforge.net/projects/hype/files/latest_docs/|pdf-file]]. |
+ | |||
+ | [[start:HYPE_file_reference|HYPE file reference]] on this wiki. As exported [[http://sourceforge.net/projects/hype/files/latest_docs/|pdf-file]]. | ||
+ | |||
+ | |{{:HHcode_structure_simple.png?100|code}}|[[http://sourceforge.net/projects/hype/files/latest_docs/HYSS_HYPE_code_overview.pdf/download|The structure of the HYPE code.]] Download pdf-file with an overview of HYPE code structure.| | ||
|{{:callgraphdenitrification.png?100|code detail}}|[[http://hype.sourceforge.net/doxy-html/index.html|Detailed code description.]] Webpages describing Fortran-files, modules, data types and all procedures with their arguments and calls.| | |{{:callgraphdenitrification.png?100|code detail}}|[[http://hype.sourceforge.net/doxy-html/index.html|Detailed code description.]] Webpages describing Fortran-files, modules, data types and all procedures with their arguments and calls.| | ||
- | |{{:WBmark.png?100|land stores}}|[[http://sourceforge.net/projects/hype/files/latest_docs/HYPE-waterbalance.pdf/download|HYPE water balance.]] Download pdf-file with description of the special water balance output. The file give an overview of all water flows in HYPE.| | + | |{{:WBmark.png?100|land stores}}|[[http://sourceforge.net/projects/hype/files/latest_docs/HYPE-waterbalance.pdf/download|HYPE water balance.]] Download pdf-file with description of the special water balance output. The file gives an overview of all water flows in HYPE.| |
\\ | \\ | ||
- | //**NOTE: File reference pages and more technical parts are under development. Please have a look at [[http://hype.sourceforge.net]] when information is missing**// | + | //NOTE: File reference pages and more technical parts are under development.// |
\\ | \\ | ||
Line 26: | Line 26: | ||
==== How to run HYPE ==== | ==== How to run HYPE ==== | ||
- | HYPE does not provide a graphical user interface. Users provide model set-up options and input data to HYPE using input text files. Model outputs are returned as text files as well. The compiled HYPE executable is run by double-clicking (on Windows) or by call from a command line (Windows or Linux). A system installation is not required. When invoked from the command line, HYPE takes two command line arguments: The search path to the folder where the [[start:hype_file_reference:info.txt|info.txt]] file with model setup arguments is stored which has to be given, and a sequence number which is optional. | + | HYPE does not provide a graphical user interface. Users provide model set-up options and input data to HYPE using input text files. Model outputs are returned as text files as well. The compiled HYPE executable is run by double-clicking (on Windows) or by call from a command line (Windows or Linux). A system installation is not required. When invoked from the command line, HYPE takes two command line arguments: The search path to the folder where the [[start:hype_file_reference:info.txt|info.txt]] file with model setup arguments is stored which is mandatory, and a sequence number which is optional. |
^ flag ^ argument ^ | ^ flag ^ argument ^ | ||
| -infodir //or// -i | path | | | -infodir //or// -i | path | | ||
| -sequence //or// -s | seqnr | | | -sequence //or// -s | seqnr | | ||
+ | |||
+ | |||
+ | ^ flag ^ argument | 1 2 3 | | ||
+ | | -infodir //or// -i | path | ::: | | ||
+ | | -sequence //or// -s | seqnr | ::: | | ||
The path can either be given as an absolute address or relative from the folder in which the program is started. The path may have a maximum of 200 characters and need surrounding apostrophes 'path' if blanks are included in the path. The search path should end with a slash. The sequence number is an integer between 0 and 999. The sequence number determines which forcing files to use. Seqnr 0 uses forcing files without sequence number. | The path can either be given as an absolute address or relative from the folder in which the program is started. The path may have a maximum of 200 characters and need surrounding apostrophes 'path' if blanks are included in the path. The search path should end with a slash. The sequence number is an integer between 0 and 999. The sequence number determines which forcing files to use. Seqnr 0 uses forcing files without sequence number. | ||
- | If no argument is found, the program tries to find a file filedir.txt in the starting folder and read the path to info.txt there. It is also possible to give the path as the only argument without the flag. | + | If no argument is found, the program tries to find a file filedir.txt in the starting folder and read the path to info.txt there. It is also possible to give the path as the only argument without the -i flag. |
===== Tutorials ===== | ===== Tutorials ===== | ||
- | Tutorials on the HYPE wiki pages. | + | Tutorials can be found on the [[::start:hype_tutorials|tutorial page]] on the HYPE wiki. The collection will be expanded as more introductions are written. Some popular tutorials are: |
+ | |||
+ | - [[start:HYPE_tutorials:short_intro|Short version on using HYPE]] | ||
+ | |||
+ | - [[start:HYPE_tutorials:hype_setup_tutorial|HYPE set-up tutorial]] | ||
- | [[start:HYPE_tutorials:short_intro|Short version on using HYPE]] | + | - [[start:HYPE_tutorials:updating|Updating with discharge and other observations]] |
- | [[start:HYPE_tutorials:hype_setup_tutorial|HYPE set-up tutorial]] | ||
- | [[start:HYPE_tutorials:updating|Updating with flow observations and more]] |