KiLib-OSS

Version v6.3.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

$ git clone https://github.com/CoSci-LLC/KiLib-OSS.git
$ cmake --preset <Debug|Release>
$ cmake --build . --preset <Debug|Release>
$ cmake --build . --target install --preset <Debug|Release>

Windows

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

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

$ git clone https://github.com/CoSci-LLC/KiLib-OSS.git
$ cmake --preset msvc
$ cmake --build . --preset msvc
$ cmake --build . --target install --preset msvc

MacOS

After installing XCode, run the following:

$ git clone https://github.com/CoSci-LLC/KiLib-OSS.git
$ cmake --preset macOS
$ cmake --build . --preset macOS
$ cmake --build . --target install --preset macOS

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 v6.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)

Classes

Hydrology

KiLib/Hydrology/Hydrology.hpp: Implements hydrological models (TOPMODEL, TOPOG, Iverson2000STST ---Iverson, 2000, Saturated-Transient-Short-Term) and infiltration models (Stone2008 --- Stone et al 2008, Bonetti2021 --- Bonetti et al 2021)

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.