The lumpR-package requires the free software R, making it largely platform independent. It interacts with the free GRASS GIS. Subsequent steps use different options for database (see chapter Database on the right for detailed information).

Install the free software R. For ease-of-use, you may also want to consider using the GUI RStudio / Posit .

To include the lumpR library to your R installation, you can use one of the following procedures.

The following procedures were tested under Linux opensuse and R version 3.1.2 adn Linux Mint, R version 4.3.

# install devtools
install.packages("devtools")  
# load library devtools  
library(devtools)  
# install directly from github (master branch by default)  
install_github("tpilz/lumpR")

OR
Download a release archive file <release_name>.tar.gz. In R execute the following:

install.packages("/path/to/file/<release_name>.tar.gz")

Download a release archive file <release_name>.tar.gz. Open a shell, go to the download directory containing the release file and install the package:

cd path/to/release
R CMD INSTALL <release_name>.tar.gz

If you want to contribute to lumpR, please install git. Open a shell, create a new directory, and clone the project into that directory:

mkdir <lump_directory>
cd <lump_directory>
git init
git clone https://github.com/tpilz/lumpR.git

To make changes to the package I recommend using the powerful R GUI RStudio, which can also be connected to git to keep track of changes (see e.g. this article).

The altered package can be installed to R by eiterh using the functionality built into RStudio (tab "Install" in the upper right or running R CMD INSTALL lumpR from the parent directory of the project.

To contribute changes, extensively test your modifications. Then, create a pull request at github GUI or via command line (see git / github docs).

The following procedures were tested under Windows 7 and R version 3.1.2.

Install the R package Rtools. From R command line, execute the following:

# install devtools 
install.packages("devtools")  
# load library devtools  
library(devtools)  
# install directly from github (master branch by default)  
install_github("tpilz/lumpR")

lumpR connects to the free GRASS GIS. Install GRASS on your system. On Linux, please (also) get grass-dev: sudo apt install grass grass-dev. Start GRASS and install the extensions r.stream.order and r.stream.distance, using the GUI (...) or the command line.