DEVELOP.md

In KDolos/LandClimTools: Tools for Modelling Landscapes

Windows

we currently don't have a guide on setting up the environment on Windows machines

Ubuntu

Setting up the development environment

First install the required software: git version control system PDFLaTeX (part of the texlive LaTeX-distribution) GNU R statistical computation and graphics system GNOME XML library libxml2 ≥ 2.6.3 (required by the R-package XML) Cartographic projection library proj.4 ≥ 4.4.9 (required by the R-package rgdal) Geospatial Data Abstraction Library libgdal ≥ 1.6.3 (required by the R-package rgdal)

All of those are in the main Ubuntu repositories, so they can simply be installed by executing the following command in the command line: For Ubuntu 16.04 (Xenial Xerus):

$ sudo apt install git texlive r-base libxml2-dev libproj-dev libgdal-dev

For Ubuntu 17.10 (Artful Aardvark):

$ sudo apt install git texlive r-base libxml2-dev libproj-dev libgdal-dev libudunits2-dev

Then you'll need to install the R-Packages required (as listed in the "Depends" section of the DESCRIPTION file):

$ R -e "install.packages(c('rgdal', 'raster', 'XML'), dependencies = TRUE, repos = 'https://cran.r-project.org')"

Now you have everything to start building and developing the LandClimTools package.

You can download the package from Github with the following commands. In the first command replace the dummy-path with an existing directory where you want the package to be:

$ cd /home/your-username/directory-containing-the-package/
$ git clone https://github.com/KIT-IfGG/LandClimTools.git

That's it! You are ready to build and develop. :tada: :thumbsup:

If you want, you can use an IDE (integrated development environment) like RStudio, Visual Studio Code or the StatET plugin for Eclipse.

These provide additional editing functionality like autocompletion or syntax highlighting, but they are not necessary to work with the code. Any text editor will work (e.g. Atom or Sublime Text).

We recommend RStudio, a project file for it is included in the source code.

Building the R-package

Do the following in the command line. In the first command replace the dummy-path with the correct path to the directory where you have placed the source code of LandClimTools:

$ cd /home/your-username/directory-containing-the-package/LandClimTools
$ mkdir build
$ cd build
$ R CMD build ..

After you have done that, you'll find a file called similar to LandClimTools_1.2.3.tar.gz (with the current version number) in the build/ directory.

Checking the package for errors

After building the package, you can check for errors in it by running the following command inside the build/ directory:

$ R CMD check LandClimTools_1.2.3.tar.gz

This might take a while and some windows may appear on your screen.

KDolos/LandClimTools documentation built on May 8, 2019, 4:42 p.m.