Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 1.81 KB

INSTALL.md

File metadata and controls

62 lines (44 loc) · 1.81 KB
Raw

Installation

Download and install the latest release package. Alternatively, you may install and use the library in your projects by cloning the repository, configuring, and installing the project:

git clone --depth 1 "https://github.com/FrancoisCarouge/kalman"
cmake -S "kalman" -B "build"
cmake --build "build" --parallel
sudo cmake --install "build"

The standard shared CMake configuration file provides the library target to use in your own target:

find_package(kalman)
target_link_libraries(your_target PRIVATE kalman::kalman)

In your sources, include the library header and use the filter. See the samples for more.

#include "fcarouge/kalman.hpp"

fcarouge::kalman filter;

Development Build & Run

Tests & Samples

Build and run the tests and samples:

git clone --depth 1 "https://github.com/FrancoisCarouge/kalman"
cmake -S "kalman" -B "build"
cmake --build "build" --config "Debug" --parallel
ctest --test-dir "build" --build-config "Debug" --output-on-failure --parallel

Benchmarks

See the Benchmark section.

Installation Packages

Linux

git clone --depth 1 "https://github.com/FrancoisCarouge/kalman"
cmake -S "kalman" -B "build"
cmake --build "build" --target "package" --parallel
cmake --build "build" --target "package_source" --parallel

Windows

git clone --depth 1 "https://github.com/FrancoisCarouge/kalman"
cmake -S "kalman" -B "build"
cmake --build "build" --target "package" --parallel --config "Release"
cmake --build "build" --target "package_source" --parallel --config "Release"