KISS-Matcher

(β˜… 754)

KISS-Matcher: Fast, Robust, and Scalable Registration + ROS2 SLAM examples

  • .clang-format
  • .gitignore
  • .pre-commit-config.yaml
  • CONTRIBUTING.md
  • LICENSE
  • Makefile
  • README.md

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/MIT-SPARK/KISS-Matcher

Downloads the entire project code from GitHub to your computer.

cd KISS-Matcher

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install kiss-matcher # core only (numpy)

Installs the package published on PyPI directly β€” no need to clone the source.

pip install kiss-matcher[viz] # adds viser for the visualization demo

Installs the package published on PyPI directly β€” no need to clone the source.

pip install --upgrade pip setuptools wheel scikit-build-core ninja cmake build

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
> CMake Error: Not a file: ${your_directory}/KISS-Matcher/cpp/kiss_matcher/build/_deps/robin-build/cmake_install.cmake

Type this command into your terminal and run it.

> CMake Error: Error processing file: ${your_directory}/KISS-Matcher/cpp/kiss_matcher/build/_deps/robin-build/cmake_install.cmake

Type this command into your terminal and run it.

cmake -S cpp/kiss_matcher -B build \

Type this command into your terminal and run it.

cmake --build build -j$(sysctl -n hw.ncpu)

Type this command into your terminal and run it.

pip install --upgrade pip setuptools wheel scikit-build-core ninja cmake build

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install kiss-matcher # core only (numpy)

Installs the package published on PyPI directly β€” no need to clone the source.

pip install kiss-matcher[viz] # adds viser for the visualization demo

Installs the package published on PyPI directly β€” no need to clone the source.

pip install --upgrade pip setuptools wheel scikit-build-core ninja cmake build

Installs the package published on PyPI directly β€” no need to clone the source.

pip install -e python/

Installs the Python libraries listed in requirements.txt (or similar).

<a href="https://pypi.org/project/kiss-matcher/"><img src="https://readme-typing-svg.demolab.com?font=Fira+Code&weight=500&size=17&duration=2200&pause=900&color=E5E7EB&background=111827&center=true&vCenter=true&width=460&height=48&lines=%E2%9D%AF+pip+install+kiss-matcher;%E2%9C%93+ready+for+Python" alt="pip install kiss-matcher"/></a>

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make deps

Compiles the code based on the generated build configuration to produce an executable.

make cppinstall

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation