README.md

In JBrenn/TopoSUB: TopoSUB tool

=======

TopoSUB

R package for landscape clustering and land-surface modelling preprocessing (landscape clustering, running LSM in parallel) postprocessing (read output, mapping) * data analysis (specific variable postprocessing, e.g. drought indices)

TopoSUB is a R project for sampling the most important aspects of land surface heterogeneity through a lumped scheme, allowing for the application of numerical land surface models (LSMs), like e.g. GEOtop, over large areas in mountain regions or other heterogeneous environments (Fiddes et al. 2012). The project was initiated by Joel Fiddes, the source code is available via the toposub GitHub repository.

=======

Reference

Fiddes, J., & Gruber, S. (2012). TopoSUB: A tool for efficient large area numerical modelling in complex topography at sub-grid scales. Geoscientific Model Development, 5(5), 1245–1257. DOI: 10.5194/gmd-5-1245-2012

How to start

First install the package with:

install.packages("devtools")
library(devtools)
install_github("JBrenn/TopoSUB")

# with vignettes built
install_github("JBrenn/TopoSUB", build_vignettes = TRUE)

and then import the library with:

library(TopoSUB)

Simulation Workflow

A TopoSUB simulation is started with the function TopoSUB_preprocessor. After preparing GEOtop input files (raster maps, meteorological input stations, horizon files, ...), the GEOtop configuration file (geotop.inpts) and the TopoSUB configuration files (locations.txt, setup.txt), use this function to carry out landscape clustering and GEOtop point simulations, for computational intensive simulations preferable parallelized on a HPC server. See the function documentation for a short description.

?TopoSUB_preprocessor

Postprocessing of the GEOtop output is perfomed by the functions

• TopoSUB_read: reading GEOtop output, specified by keywords in geotop.inpts

• TopoSUB_remap: maping of the output data table of the function above for different time/climatic periods and/or differences of time/climatic periods

An example simulation for the Montatschinig/Montecini region (LTER Matsch/Mazia) can be found here. Use this example as a template to create an TopoSUB-GEOtop simulation folder. See also the TopoSUB configuration files (locations.txt and setup.txt) and define parmeters, e.g. input/output folders, number of cluster centroids, specific switches, definitions for running the simulation on a HPC cluster, ... For running the example use the R script main_pre.R after changing the root folder and GEOtop LSM exe Path in locations.txt

Moreover, the package includes an easy to use shiny app for visualisation. Run in the simulation folder it visualises the finally produced maps (still Beta-version, see folder shiny).

The TopoSUB package includes vignettes on the topics

1. running a TopoSUB simulation
2. postprocessing a TopoSUB simulation
3. visualisation of TopoSUB simulation output

You can install the package with the option of building the vignettes and list/open them in an HTML browser:

library(devtools)
install_github("JBrenn/TopoSUB", build_vignettes = TRUE)

browseVignettes("TopoSUB")

JBrenn/TopoSUB documentation built on May 7, 2019, 7:39 a.m.