Difference between revisions of "Topmodel"

Revision as of 09:10, 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 hydrology in R pages

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.3.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()

@@ Line 4: / Line 4: @@
 ==Introduction==
-The package TOPMODEL contains some functions and code snippets for hydrological data analysis with R, that may eventually make it into a properly released R package. For now, the code can be downloaded on this page and used at your own risk, without official support (although I very much welcome all feedback). The core of the package is an implementation of the venerable TOPMODEL.
+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).
-Information on R, including downloads, installation and a great choice of manuals can be found on the [http://www.r-project.org R website]. If you follow strictly the examples used below, you will be able to run TOPMODEL with a very limited R knowledge. However, R has a great potential for pre- en postprocessing of the data (including uncertainty analysis and statistics), so a more extensive knowledge of R is highly recommended!
 Thanks go to [http://www.lec.lancs.ac.uk/cswm/Staff_kb.php Keith Beven], who wrote the original TOPMODEL in Fortran, and [http://geni.ath.cx/ Huidae Cho], for the C code base (originally implemented in [http://grass.osgeo.org/ GRASS GIS])
@@ Line 14: / Line 12: @@
 ==Downloads==
-* [http://www.paramo.be/topmodel/topmodel_0.3.zip Windows binary (experimental)]
+* [http://www.paramo.be/topmodel/topmodel_0.3.zip Windows binary]
 * [http://www.paramo.be/topmodel/topmodel_0.3.tar.gz Linux source package]
-* [http://www.paramo.be/topmodel/topmodel_0.3.tgz Universal MacOS X package (experimental)]
+* [http://www.paramo.be/topmodel/topmodel_0.3.tgz Universal MacOS X package]
 ==Installation==
@@ Line 44: / Line 42: @@
 ==Function overview==
-For the full documentation, see the installed manpages in R
+Full documentation is provided in the package, and can be opened with:
+   > help.start()