Difference between revisions of "Topmodel"
| Line 12: | Line 12: | ||
==Downloads== | ==Downloads== | ||
| − | * [http://www.paramo.be/topmodel/topmodel_0. | + | * [http://www.paramo.be/topmodel/topmodel_0.5.zip Windows binary] |
| − | * [http://www.paramo.be/topmodel/topmodel_0. | + | * [http://www.paramo.be/topmodel/topmodel_0.5.tar.gz Linux source package] |
| − | * [http://www.paramo.be/topmodel/topmodel_0. | + | * [http://www.paramo.be/topmodel/topmodel_0.5.tgz Universal MacOS X package] |
==Installation== | ==Installation== | ||
| Line 26: | Line 26: | ||
Use the normal procedure of installing a package in R: | Use the normal procedure of installing a package in R: | ||
| − | > R CMD install topmodel_0. | + | > R CMD install topmodel_0.5.tar.gz |
Developer tools, including gcc, must be installed. | Developer tools, including gcc, must be installed. | ||
| Line 38: | Line 38: | ||
Once in R you need to load the package before you can use it: | Once in R you need to load the package before you can use it: | ||
| − | + | library(topmodel) | |
==Function overview== | ==Function overview== | ||
| Line 44: | Line 44: | ||
Full documentation is provided in the package, and can be opened with: | Full documentation is provided in the package, and can be opened with: | ||
| − | + | help.start() | |
| + | |||
| + | The current version contains the following functions: | ||
| + | |||
| + | * ''infiltration()'' gives direct access to the Green-Ampt infiltration routine used by topmodel | ||
| + | * ''make.classes()'' makes topographic index classes from a topographic index map | ||
| + | * ''NSeff()'' calculates the Nash-Sutcliffe efficiency | ||
| + | * ''topidx()'' calculates the topographic index from a raster DEM | ||
| + | * ''topmodel()'' implements the original model | ||
Revision as of 21:12, 2 August 2008
Introduction
The TOPMODEL package contains an implementation of the venerable TOPMODEL, along with some other useful functions. Although the package has been tested extensively, it may be contain bugs. All feedback is welcome (see the feedback page).
Thanks go to Keith Beven, who wrote the original TOPMODEL in Fortran, and Huidae Cho, for the C code base (originally implemented in GRASS GIS)
For a fully documented example, see the Running Topmodel page.
Downloads
Installation
Windows
Local packages can be installed from the menu. Choose "install package(s) from local zip files" and select the downloaded topmodel_0.3.zip file.
Linux
Use the normal procedure of installing a package in R:
> R CMD install topmodel_0.5.tar.gz
Developer tools, including gcc, must be installed.
Mac
Go to the Package Installer (Packages and Data menu), select "Local Binary Package", click install and select the downloaded package
Loading
Once in R you need to load the package before you can use it:
library(topmodel)
Function overview
Full documentation is provided in the package, and can be opened with:
help.start()
The current version contains the following functions:
- infiltration() gives direct access to the Green-Ampt infiltration routine used by topmodel
- make.classes() makes topographic index classes from a topographic index map
- NSeff() calculates the Nash-Sutcliffe efficiency
- topidx() calculates the topographic index from a raster DEM
- topmodel() implements the original model