Difference between revisions of "Model:PsHIC"

m (Text replacement - "{{Include_references_models_cargo}}" to "{{Include_featured_references_models_cargo}}<br>")
Line 5: Line 5:
{{End a table}}
{{End a table}}
{{Model identity2
{{Model identity2
|ModelDomain=Hydrology, Terrestrial
|ModelDomain=Terrestrial, Hydrology
|Spatial dimensions=2D
|Spatial dimensions=2D
|Spatialscale=Landscape-Scale, Watershed-Scale
|Spatialscale=Landscape-Scale, Watershed-Scale
Line 48: Line 48:
|Does model development still take place?=No
|Does model development still take place?=No
|End year development=2009
|End year development=2009
|DevelopmentCode=As is, no updates are provided
|Model availability=As code
|Model availability=As code
|Source code availability=Through CSDMS repository
|Source code availability=Through CSDMS repository

Revision as of 12:23, 14 April 2020



Also known as
Model type Tool
Model part of larger framework
Incorporated models or components:
Spatial dimensions 2D
Spatial extent Landscape-Scale, Watershed-Scale
Model domain Terrestrial, Hydrology
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.

geomorphologic, catchment,

Name Sagy Cohen
Type of contact Model developer
Institute / Organization The University of Newcastle
Postal address 1
Postal address 2
Town / City Callaghan
Postal code 2308
Country Australia
Email address sagy.cohen@uon.edu.au

Name Garry Willgoose
Type of contact
Institute / Organization The University of Newcastle
Postal address 1
Postal address 2
Town / City
Postal code
Country Australia
Email address

Name Greg Hancock
Type of contact
Institute / Organization The University of Newcastle
Postal address 1
Postal address 2
Town / City
Postal code
Country Australia
Email address

Supported platforms
Unix, Linux, Mac OS, Windows
Other platform
Programming language


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 As is, no updates are provided
When did you indicate the 'code development status'? 2020
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:
  1. DEM
  2. 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):
  1. HI.txt - pixel scale hypsometric integral;
  2. max_elev.txt - the maximum elevation of the catchment flowing thorough each pixel;
  3. Elev_Acc.txt - the sum of the elevation (m) of all the pixels flowing thorough each pixel;
  4. flowacc.txt - Contributing area in pixels;

To change the names of the output files, edit the last section of the source code.

  1. 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 No but possible
BMI compliant No but possible
WMT component No but possible
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 https://csdms.colorado.edu/pub/models/doi-source-code/pshic-10.1594.IEDA.100154-0.1.tar.gz
Can be coupled with:
Model info
Sagy Cohen
Willgoose, Hancock

Nr. of publications: 2
Total citations: 53
h-index: 1
m-quotient: 0.07
Qrcode PsHIC.png
Link to this page




Nr. of publications: 2
Total citations: 53
h-index: 1
m-quotient: 0.07

Featured publication(s)YearModel describedType of ReferenceCitations
Cohen, S.; Willgoose, G.; Hancock, G.; 2011. PsHIC, version 0.1.. , , https://csdms.colorado.edu/pub/models/doi-source-code/pshic-10.1594.IEDA.100154-0.1.tar.gz. 10.1594/IEDA/100154
(View/edit entry)
2011 PsHIC

Source code ref.

See more publications of PsHIC



If you need assistance email me to:


Input Files

Output Files