Model:PsHIC

PsHIC

Also known as
Model type	Tool
Model part of larger framework
Note on status model
Date note status model

Incorporated models or components:

Spatial dimensions	2D
Spatial extent	Landscape-Scale, Watershed-Scale
Model domain
One-line model description	Pixel-scale Hypsometric Integral Calculator
Extended model description	Calculate the hypsometric integral for each pixel at the catchment. Each pixel is considered a local outlet and the hypsometric integral is calculated according to the characteristics of its contributing area.

Keywords:	geomorphologic, catchment,

Supported platforms	Unix, Linux, Mac OS, Windows
Other platform
Programming language	Matlab
Other program language
Code optimized	Single Processor
Multiple processors implemented
Nr of distributed processors
Nr of shared processors
Start year development	2006
Does model development still take place?	No
If above answer is no, provide end year model development	2009
Code development status
When did you indicate the 'code development status'?
Model availability	As code
Source code availability (Or provide future intension)	Through CSDMS repository
Source web address
Source csdms web address	https://github.com/csdms-contrib/pshic
Program license type	Other
Program license type other
Memory requirements	low, depending on dataset
Typical run time	short, depending on the dataset

Describe input parameters	Two input files, all in ESRI ASCII format: DEM Flow direction grid (D8) To change the input files, edit lines 19 for DEM and line 20 for Flow-direction in the source code.
Input format	ASCII
Other input format
Describe output parameters	Produce 5 output files (ESRI ASCII format): HI.txt - pixel scale hypsometric integral; max_elev.txt - the maximum elevation of the catchment flowing thorough each pixel; Elev_Acc.txt - the sum of the elevation (m) of all the pixels flowing thorough each pixel; flowacc.txt - Contributing area in pixels; To change the names of the output files, edit the last section of the source code. junctions.txt - how many of a pixel's 8 neighbors flow into it;
Output format	ASCII
Other output format
Pre-processing software needed?	Yes
Describe pre-processing software	ArcGIS to produce the flow direction file and convert the files to ESRI ASCII format.
Post-processing software needed?	Yes
Describe post-processing software	ArcGIS or other GIS package to convert the ASCII files to maps.
Visualization software needed?	Yes
If above answer is yes	ESRI, Matlab
Other visualization software

Describe processes represented by the model
Describe key physical parameters and equations	Calculate the hypsometric integral by HI = (Zbar-Zo)/(Zmax-Zo) where Zbar is the average elevation of the contributing area to a pixel Zo is the local elevation (the elevation of a pixel) Zmax is the maximum elevation of a pixel contributing area. For more details read: Cohen, S., G. Willgoose, and G. Hancock (2008), A methodology for calculating the spatial distribution of the area-slope equation and the hypsometric integral within a catchment, Journal of Geophysical Research, 113, F03027.
Describe length scale and resolution constraints
Describe time scale and resolution constraints
Describe any numerical limitations and issues

Describe available calibration data sets
Upload calibration data sets if available:
Describe available test data sets	A small DEM and Flow-direction ASCII files
Upload test data sets if available:	Media:DEM demo.txt, Media:FlowDir demo.txt
Describe ideal data for testing

Do you have current or future plans for collaborating with other researchers?

Is there a manual available?	No
Upload manual if available:
Model website if any
Model forum / discussion board

Comments	[[Additional comments model::Running instructions: Copy your input files to the source file directory (or the other way around); Launch MATLAB ; In MATLAB- map the the model directory; Edit the input file name in the source-code file (lines 19 & 20); [Optional] edit the output file names (at the last part of the source-code); Run the script via MATLAB; The output files will be created in the same directory; Use MATLAB to visualize the output or import them to ArcGIS or other GIS package; Good luck]]

This part will be filled out by CSDMS staff

OpenMI compliant	Not yet"Not yet" is not in the list (Yes, No but planned, No but possible, No not possible) of allowed values for the "Code openmi compliant or not" property.
BMI compliant	Not yet"Not yet" is not in the list (Yes, No but planned, No but possible, No not possible) of allowed values for the "BMICompliant" property.
WMT component	Not yet"Not yet" is not in the list (Yes, In progress, No but possible, No not possible) of allowed values for the "Code CMT compliant or not" property.
PyMT component
Is this a data component

DOI model	10.1594/IEDA/100154
For model version	0.1
Year version submitted	2011
Link to file	http://csdms.colorado.edu/pub/models/doi-source-code/pshic-10.1594.IEDA.100154-0.1.tar.gz

Can be coupled with:

Model info

Authors

Willgoose, Hancock

Source code

DOI

Model citations

QR-code

Link to this page

Other models by author

If you need assistance email me to:

sagy.cohen@uon.edu.au