KiLib-OSS

Version v5.1.0

A Scientific Library for "Earth" (Ki) surface processes

Dependencies

All dependencies required for this library will be download via the CMake build process

Building and Installation

Linux

$ mkdir build
$ cd build 
$ cmake .. -DCMAKE_INSTALL_PREFIX=<install location>
$ cmake --build .
$ cmake --install .

If you wish to build using Ninja, change the generator that cmake uses by:

cmake .. -G Ninja -DCMAKE_INSTALL_PREFIX=<install location>

If you wish to build using Google tests, add:

cmake .. -G Ninja -DKILIB_BUILD_TESTS=Yes

Windows

Visual Studio 2019 is the preferred method for building KiLib on Windows. CMake is also required.

Clone or download the KiLib Library and open a VS 2019 Developer Console in that directory. Then:

$ mkdir build
$ cd build
$ cmake ..
$ cmake --build .

MacOS

To install on MacOS, you first need to install HomeBrew.

Then, run:

brew install libomp cmake

Then you can build normally

Usage

To automatically download KiLib, add the following to your CMakeLists.txt:

### KiLib Install Process
include(FetchContent)

FetchContent_Populate(
    kilib_proj
    QUIET
    GIT_REPOSITORY https://github.com/CoSci-LLC/KiLib-OSS.git
    GIT_TAG v5.1.0
    SOURCE_DIR     kilib_proj              # (Relative) path within in the build directory.
)

# ------------------------------------------------------------------------------------
# And now you can already add and use it, like it's a part/target of your own project!

add_subdirectory(${kilib_proj_SOURCE_DIR} kilib_proj/build)
include_directories(${kilib_proj_SOURCE_DIR} ${CMAKE_INSTALL_PREFIX}/include)

# To be able to use stats lib
include_directories(${stats_proj_SOURCE_DIR}/include)

Then to use in your project, use:

target_link_libraries(${projectName} PUBLIC KiLib)

Debug Builds

KiLib has the option to be built with debugging features. This will enable debug prints (as long as spdlog active level is set to debug as well) and it will add stack traces and other useful debugging features. To build KiLib in debug mode, add the -DCMAKE_BUILD_TYPE=Debug flag to your CMake command like:

...
$ cmake .. -DCMAKE_INSTALL_PREFIX=<install location> -DCMAKE_BUILD_TYPE=Debug
...

Building in Debug mode will also build the tests for KiLib.

Running Tests

To run KiLib tests, follow these commands:

$ mkdir build
$ cd build 
$ cmake .. -DCMAKE_INSTALL_PREFIX=<install location> -DCMAKE_BUILD_TYPE=Debug
$ cmake --build .
$ cmake --install .
$ ctest

The make install or equivalent is important because KiLib tests require the soils to be installed in the proper location for a few of the tests to pass.

Classes

Hydrology

(KiLib/Hydrology/Hydrology.hpp) Implements hydrological models such as TOPMODEL.

Raster

(KiLib/Raster/Raster.hpp) Raster class that can read/write DEM (Digital Elevation Model) files in TIFF or ASCII format.

SoilDepth

(KiLib/SoilDepth/SoilType.hpp) Implements different models for computing soil depth based on slope or elevation.

Soils

(KiLib/Soils/SoilType.hpp) Includes SoilType class that contains soils physical properties.

Stability

(KiLib/Stability/SafetyFactor/MDSTAB.hpp) Implements factor of safety calculations using the MD-STAB model of Milledge et al. (2014).

Utils

(KiLib/Utils/Distributions.hpp) Implements several useful probability distribution related functions that are used throughout this code.

(KiLib/Utils/Vec3.hpp) General-purpose 3-dimensional vector class. It supports many different operations.

(KiLib/Utils/NewtonRaphson.hpp) Implements a Newton-Raphson scheme to find roots of non-linear equations.

benpm/KiLib-OSS