Difference between revisions of "How to get RHESSys"

From Rhessys
Jump to navigationJump to search
 
(7 intermediate revisions by the same user not shown)
Line 15: Line 15:
  
 
(this will download the most recent RHESSys version that was checked in and may still be undergoing bug fixes)
 
(this will download the most recent RHESSys version that was checked in and may still be undergoing bug fixes)
 +
  
 
When the download completes, a message will print to the screen "Checked out revision ###".  Take note of this revision number. A directory called 'trunk' will download (to the directory you are in) containing all the RHESSys code directories/files.  It may be useful to append the revision number to the directory called trunk, i.e. trunk###, in the event you do not want future downloads to overwrite the code for this particular version.  Also, after compiling RHESSys, if the revision number is not already contained in the executable name, it may be useful to include it, i.e. rhessys5.15.r### (recommended).
 
When the download completes, a message will print to the screen "Checked out revision ###".  Take note of this revision number. A directory called 'trunk' will download (to the directory you are in) containing all the RHESSys code directories/files.  It may be useful to append the revision number to the directory called trunk, i.e. trunk###, in the event you do not want future downloads to overwrite the code for this particular version.  Also, after compiling RHESSys, if the revision number is not already contained in the executable name, it may be useful to include it, i.e. rhessys5.15.r### (recommended).
  
While RHESSys itself is a stand alone C program that can be compiled and run on it's own, in order to install/compile certain RHESSys programs (g2w to create a worldfile and CF to create a flowtable), GRASS GIS libraries and header files must first be installed.  Therefore, before compiling g2w and CF, you must first install GRASS GIS.
+
While RHESSys itself is a stand alone C program that can be compiled and run on it's own, in order to install/compile certain RHESSys programs (g2w to create a worldfile (required to run RHESSys) and CF to create a flowtable), GRASS GIS libraries and header files must first be installed.  Therefore, before compiling g2w and CF, you must first install GRASS GIS. (see [[Installing RHESSys and associated programs]])
  
 
Trunk contents:
 
Trunk contents:
makefile - to be used for global installation, must be signed in as root to use.  each subdirectory (as follows) contains an independent makefile to compile each program individually, can be used for local installation.  
+
 
 +
makefile - to be used for global installation, must be signed in as root to use.  each subdirectory (as follows) contains an independent makefile to compile each program individually, can be used for local installation.
 +
 
rhessys - RHESSys code files
 
rhessys - RHESSys code files
 +
 
The following are RHESSys/GRASS interface programs and require GRASS first be installed before they can be compiled:
 
The following are RHESSys/GRASS interface programs and require GRASS first be installed before they can be compiled:
 +
 
g2w - Grass to World and Average Tables code
 
g2w - Grass to World and Average Tables code
 +
 
cf - Create Flowpaths code  
 
cf - Create Flowpaths code  
create_in_files - non standard functionality programs used for more specific applications:
+
 
          cst - used with in stream routing
+
create_in_files - non standard functionality programs used for more specific applications: cst - used with in stream routing; lairead - used to initialize vegetation from spatial data inputs
          lairead - used to initialize vegetation from spatial data inputs
+
 
util - Useful utilities and tools. Contains some RHESSys/GRASS interface programs.
+
util - Useful utilities and tools. Contains some RHESSys/GRASS interface programs (cxy - used to create x/y maps).

Latest revision as of 17:47, 11 October 2012

Getting the RHESSys source code

The source for RHESSys and various tools for use with RHESSys is hosted on sourceforge and accessible via anonymous subversion access.

The latest stable release can be checked out with the following terminal window command:

$> svn co -r 318 https://rhessys.svn.sourceforge.net/svnroot/rhessys/trunk/

(the -r ### will download the latest RHESSys version deemed stable)


The latest development version can be checked out with the following terminal window command:

$> svn co https://rhessys.svn.sourceforge.net/svnroot/rhessys/trunk/

(this will download the most recent RHESSys version that was checked in and may still be undergoing bug fixes)


When the download completes, a message will print to the screen "Checked out revision ###". Take note of this revision number. A directory called 'trunk' will download (to the directory you are in) containing all the RHESSys code directories/files. It may be useful to append the revision number to the directory called trunk, i.e. trunk###, in the event you do not want future downloads to overwrite the code for this particular version. Also, after compiling RHESSys, if the revision number is not already contained in the executable name, it may be useful to include it, i.e. rhessys5.15.r### (recommended).

While RHESSys itself is a stand alone C program that can be compiled and run on it's own, in order to install/compile certain RHESSys programs (g2w to create a worldfile (required to run RHESSys) and CF to create a flowtable), GRASS GIS libraries and header files must first be installed. Therefore, before compiling g2w and CF, you must first install GRASS GIS. (see Installing RHESSys and associated programs)

Trunk contents:

makefile - to be used for global installation, must be signed in as root to use. each subdirectory (as follows) contains an independent makefile to compile each program individually, can be used for local installation.

rhessys - RHESSys code files

The following are RHESSys/GRASS interface programs and require GRASS first be installed before they can be compiled:

g2w - Grass to World and Average Tables code

cf - Create Flowpaths code

create_in_files - non standard functionality programs used for more specific applications: cst - used with in stream routing; lairead - used to initialize vegetation from spatial data inputs

util - Useful utilities and tools. Contains some RHESSys/GRASS interface programs (cxy - used to create x/y maps).