Repository Summary
| Description | |
| Checkout URI | https://github.com/rsasaki0109/lidarslam_ros2.git |
| VCS Type | git |
| VCS Version | develop |
| Last Updated | 2026-11-18 |
| Dev Status | UNKNOWN |
| Released | UNRELEASED |
| Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
| Name | Version |
|---|---|
| lidarslam_registration_plugin_template | 0.1.0 |
| graph_based_slam | 0.13.0 |
| lidarslam | 0.13.0 |
| lidarslam_default_plugins | 0.6.0 |
| lidarslam_fake_registration_plugins | 0.6.0 |
| lidarslam_msgs | 0.13.0 |
| lidarslam_plugin_interfaces | 0.6.0 |
| lidarslam_registration_loader | 0.6.0 |
| scanmatcher | 0.13.0 |
README
lidar_slam
Turn a rosbag into a map you can actually drive on. LiDAR SLAM that writes an Autoware-compatible map bundle: pointcloud_map/, map_projector_info.yaml and lanelet2. It runs as ROS 2 packages (Humble, Jazzy) or without ROS 2 from pip install lidarslam. RKO-LIO (MIT) + graph_based_slam (BSD-2), no GPL on the default workflow. Try it in your browser · Open in Colab · 日本語クイックスタート · release notes v0.13.0 · v0.12.0
Documentation · Supported inputs and outputs · Workflow and benchmark comparison
Outdoor walk, APE 0.55 m (Koide, CC BY 4.0) · camera-coloured park (RTK-SLAM, CC BY 4.0) · stairs, ATE 0.24 m on development data · held-out metro tunnel, 0.38 m like BIEVR-LIO and FAST-LIO2 (GEODE) · three separate walks joined into one map with no position hint (Oxford Spires, CC BY-NC-SA 4.0). How these were made.
Quickstart
Choose your shortest path
| Goal | Start here | Safety and cost boundary |
|---|---|---|
| See a verified map, no build | Default if unsure: Docker demo | Stable v0.12.0-humble; needs Docker; host writes stay in ./lidarslam_output. |
| Map my own rosbag |
Own-bag route: lidarslam-map doctor /path/to/rosbag2
|
Read-only diagnosis first; then lidarslam-map start /path/to/rosbag2 writes a new output. |
| Build from source or contribute |
Source quickstart: bash scripts/source_quickstart.sh --dry-run
|
Release v0.12.0; needs ROS 2, 8 GiB, and roughly 30 minutes. |
| Map a bag without ROS 2 (preview) |
pip install: pip install lidarslam-*.whl (prebuilt) or pip install ./lidarslam_core, then lidarslam-map start /path/to/rosbag2
|
No ROS 2; the prebuilt wheel needs no apt packages (Linux x86_64/aarch64, Python 3.10-3.13). RKO-LIO profiles; with --lidarslam-param lidarslam_rtk_gnss.yaml the map is anchored to the bag’s RTK GNSS (/gnss/fix); Velodyne packet bags (VelodyneScan + Imu) with --engine core. The classic GNSS and packet profiles need ROS 2. |
Try it with Docker (one command, no build)
docker run --rm -e LIDARSLAM_HOST_UID="$(id -u)" -e LIDARSLAM_HOST_GID="$(id -g)" \
-v "$PWD/lidarslam_output:/lidarslam_ws/output" \
ghcr.io/rsasaki0109/lidar_slam_ros2:v0.12.0-humble
The repository was renamed from lidar_slam_ros2 to lidar_slam; the v0.12.0 images keep their published name ghcr.io/rsasaki0109/lidar_slam_ros2, and old GitHub links redirect.
The 517 MB MID-360 demo writes lidarslam_output/mid360_demo/ as your user. Other platforms: Getting Started.
Map your own bag (one command after install)
lidarslam-map start /path/to/rosbag2
Run lidarslam-map with no arguments for a guided start, or lidarslam-map doctor first: it uses no network and writes no files. See supported inputs.
Build + verified demo from source (one helper)
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
bash scripts/source_quickstart.sh
The helper detects Humble/Jazzy, installs the dependencies, builds the six maintained packages and runs the verified demo (--dry-run, --build-only). It prints a lidarslam-map path that auto-activates this build. Needs ROS 2, 8 GiB and about 30 minutes. Before handoff: python3 scripts/check_first_map_verification_package.py --json, continue only on READY.
Without ROS 2 (pip, preview)
ROS 2 is becoming one option rather than a requirement. The pip package installs the lidarslam-map command with the RKO-LIO odometry and the graph_based_slam backend (loop closure, pose graph, refinement, Autoware map bundle) inside, and reads rosbag2 (MCAP, SQLite3) and ROS 1 bags without ROS 2 (roadmap).
Prebuilt wheel (no apt packages, no compiler). The wheels workflow builds manylinux wheels (glibc 2.28+, x86_64 and aarch64, Python 3.10-3.13) that bundle PCL, g2o and the other C++ libraries. From the first release published to PyPI on, pip install lidarslam installs them. Until then, open the latest successful run on develop, download lidarslam-wheels-x86_64 (or -aarch64; GitHub sign-in needed), unzip it and install the wheel for your Python:
python3 -m venv .venv && . .venv/bin/activate
pip install lidarslam-*-cp312-cp312-manylinux_2_28_x86_64.whl # your cpXY and arch
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
On HILTI exp14 the x86_64 wheel writes the same map bytes as the source install below.
From source (Ubuntu packages, builds the C++ core):
sudo apt install build-essential cmake libeigen3-dev libtbb-dev robin-map-dev \
libpcl-dev libg2o-dev libzstd-dev python3-venv # tested on Ubuntu 24.04
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
python3 -m venv .venv && . .venv/bin/activate
pip install ./lidarslam_core # Python >= 3.10; downloads Sophus while building
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
python -m lidarslam inspect /path/to/rosbag2 # topics and message types
python -m lidarslam odometry /path/to/rosbag2 --params my_rko_lio.yaml --out odom/
python -m lidarslam map /path/to/rosbag2 --odometry-params my_rko_lio.yaml \
--backend-params lidarslam/param/lidarslam.yaml --out map/ # both, in one pass
python -m lidarslam backend /path/to/backend_input \
--params lidarslam/param/lidarslam_mid360_rko_graph_walking.yaml --out map/ \
-p "extrinsic_lidar2base_quat_xyzw_xyz:=[0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0]"
--params takes the same parameter file as the ROS 2 RKO-LIO node (ros__parameters layout), with imu_topic, lidar_topic, base_frame and both extrinsic_*2base_quat_xyzw_xyz set. On HILTI exp14 the trajectory is byte-identical to the ROS 2 offline node. Visual and radar fusion still need ROS 2. A lidar_topic of Velodyne packets (velodyne_msgs/msg/VelodyneScan) is decoded as velodyne_transform_node does; set velodyne.model (VLP16 by default, 32C, 32E, VLS128) or velodyne.calibration. The decoder’s per-point time counts from the scan stamp, so lidar_timestamps.force_relative is set for packet input unless the parameter file sets lidar_timestamps.force_relative or force_absolute.
File truncated at 100 lines see the full file
CONTRIBUTING
Contributing
Thanks for contributing to lidarslam_ros2.
This repository is trying to be a practical default for ROS 2 LiDAR SLAM and Autoware pointcloud-map generation. Contributions are most useful when they are easy to reproduce, easy to compare, and clearly scoped.
Participation is governed by the Code of Conduct. The Governance, Support, and Security policies explain decisions, help routes, and private vulnerability reporting.
What To Send
Useful contributions include:
- bug fixes in the default permissive workflow
- Autoware pointcloud-map integration fixes
- benchmark results with reproducible commands and artifacts
- parameter improvements backed by logs and trajectory metrics
- documentation improvements that reduce setup time
Default Workflow Policy
The default and recommended workflow in this repository is permissive-license only. Contributions that change the default path should preserve that property.
Current default path:
RKO-LIO + graph_based_slam- local Scan Context implementation
- Autoware-compatible pointcloud map output
Research frontends with other licenses can still be discussed, but they should not silently become the default path.
Repository Layout
Keep the repository root limited to project metadata and primary entry-point
documents. Place commands under scripts/, offline libraries under tools/,
and small research outputs under docs/research/artifacts/. Do not commit
colcon manifests or other generated build products. See the
repository layout guide for the complete map.
Autoware Naming And Trademark Guidance
Keep Autoware references descriptive.
Preferred wording:
Autoware-compatible pointcloud mappointcloud-map workflow for Autowareworks with Autowarebuilt on Autoware
Avoid branding this repository or a derived product as if it were an official Autoware product or a Foundation-approved distribution.
Avoid wording such as:
-
Autoware-readyas a product tag line official AutowareAutoware <product-name>certified by Autowareendorsed by the Autoware Foundation
If in doubt, prefer compatibility language over product-name language.
Before Opening An Issue
Please collect the smallest reproducible case you can. Use the structured bug, feature, sensor-support, benchmark, or Autoware issue form that best matches the request. Usage questions must include the diagnostic bundle listed in SUPPORT.md.
If you completed a first map from the public docs without live maintainer guidance, use the independent first-map validation form. Passing reports may count toward the v1.0 three-user gate; failed attempts are recorded as onboarding findings and are just as valuable.
For bug reports, keep ordinary doctor <bag> --json output local because it
contains the bag path and local commands. Instead run and review:
lidarslam-map doctor <rosbag2_dir> --public-json
Paste that complete public-doctor-evidence-v1 path-free JSON, a redacted
command shape, expected/observed behavior, and either one reviewed support ZIP
from an existing session or an explicit no-session/no-ZIP statement with the
first finding code. Never attach a bag, map, trajectory, raw log/data,
parameter file, terminal history, or private-site image.
For Autoware-related reports, include:
- projector type and whether an origin exists, with every coordinate and
MGRS/grid identifier and precise origin value replaced by
REDACTED - the non-geometry verifier findings, with private paths and precise locations
File truncated at 100 lines see the full file
Repository Summary
| Description | |
| Checkout URI | https://github.com/rsasaki0109/lidarslam_ros2.git |
| VCS Type | git |
| VCS Version | develop |
| Last Updated | 2026-11-18 |
| Dev Status | UNKNOWN |
| Released | UNRELEASED |
| Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
| Name | Version |
|---|---|
| lidarslam_registration_plugin_template | 0.1.0 |
| graph_based_slam | 0.13.0 |
| lidarslam | 0.13.0 |
| lidarslam_default_plugins | 0.6.0 |
| lidarslam_fake_registration_plugins | 0.6.0 |
| lidarslam_msgs | 0.13.0 |
| lidarslam_plugin_interfaces | 0.6.0 |
| lidarslam_registration_loader | 0.6.0 |
| scanmatcher | 0.13.0 |
README
lidar_slam
Turn a rosbag into a map you can actually drive on. LiDAR SLAM that writes an Autoware-compatible map bundle: pointcloud_map/, map_projector_info.yaml and lanelet2. It runs as ROS 2 packages (Humble, Jazzy) or without ROS 2 from pip install lidarslam. RKO-LIO (MIT) + graph_based_slam (BSD-2), no GPL on the default workflow. Try it in your browser · Open in Colab · 日本語クイックスタート · release notes v0.13.0 · v0.12.0
Documentation · Supported inputs and outputs · Workflow and benchmark comparison
Outdoor walk, APE 0.55 m (Koide, CC BY 4.0) · camera-coloured park (RTK-SLAM, CC BY 4.0) · stairs, ATE 0.24 m on development data · held-out metro tunnel, 0.38 m like BIEVR-LIO and FAST-LIO2 (GEODE) · three separate walks joined into one map with no position hint (Oxford Spires, CC BY-NC-SA 4.0). How these were made.
Quickstart
Choose your shortest path
| Goal | Start here | Safety and cost boundary |
|---|---|---|
| See a verified map, no build | Default if unsure: Docker demo | Stable v0.12.0-humble; needs Docker; host writes stay in ./lidarslam_output. |
| Map my own rosbag |
Own-bag route: lidarslam-map doctor /path/to/rosbag2
|
Read-only diagnosis first; then lidarslam-map start /path/to/rosbag2 writes a new output. |
| Build from source or contribute |
Source quickstart: bash scripts/source_quickstart.sh --dry-run
|
Release v0.12.0; needs ROS 2, 8 GiB, and roughly 30 minutes. |
| Map a bag without ROS 2 (preview) |
pip install: pip install lidarslam-*.whl (prebuilt) or pip install ./lidarslam_core, then lidarslam-map start /path/to/rosbag2
|
No ROS 2; the prebuilt wheel needs no apt packages (Linux x86_64/aarch64, Python 3.10-3.13). RKO-LIO profiles; with --lidarslam-param lidarslam_rtk_gnss.yaml the map is anchored to the bag’s RTK GNSS (/gnss/fix); Velodyne packet bags (VelodyneScan + Imu) with --engine core. The classic GNSS and packet profiles need ROS 2. |
Try it with Docker (one command, no build)
docker run --rm -e LIDARSLAM_HOST_UID="$(id -u)" -e LIDARSLAM_HOST_GID="$(id -g)" \
-v "$PWD/lidarslam_output:/lidarslam_ws/output" \
ghcr.io/rsasaki0109/lidar_slam_ros2:v0.12.0-humble
The repository was renamed from lidar_slam_ros2 to lidar_slam; the v0.12.0 images keep their published name ghcr.io/rsasaki0109/lidar_slam_ros2, and old GitHub links redirect.
The 517 MB MID-360 demo writes lidarslam_output/mid360_demo/ as your user. Other platforms: Getting Started.
Map your own bag (one command after install)
lidarslam-map start /path/to/rosbag2
Run lidarslam-map with no arguments for a guided start, or lidarslam-map doctor first: it uses no network and writes no files. See supported inputs.
Build + verified demo from source (one helper)
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
bash scripts/source_quickstart.sh
The helper detects Humble/Jazzy, installs the dependencies, builds the six maintained packages and runs the verified demo (--dry-run, --build-only). It prints a lidarslam-map path that auto-activates this build. Needs ROS 2, 8 GiB and about 30 minutes. Before handoff: python3 scripts/check_first_map_verification_package.py --json, continue only on READY.
Without ROS 2 (pip, preview)
ROS 2 is becoming one option rather than a requirement. The pip package installs the lidarslam-map command with the RKO-LIO odometry and the graph_based_slam backend (loop closure, pose graph, refinement, Autoware map bundle) inside, and reads rosbag2 (MCAP, SQLite3) and ROS 1 bags without ROS 2 (roadmap).
Prebuilt wheel (no apt packages, no compiler). The wheels workflow builds manylinux wheels (glibc 2.28+, x86_64 and aarch64, Python 3.10-3.13) that bundle PCL, g2o and the other C++ libraries. From the first release published to PyPI on, pip install lidarslam installs them. Until then, open the latest successful run on develop, download lidarslam-wheels-x86_64 (or -aarch64; GitHub sign-in needed), unzip it and install the wheel for your Python:
python3 -m venv .venv && . .venv/bin/activate
pip install lidarslam-*-cp312-cp312-manylinux_2_28_x86_64.whl # your cpXY and arch
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
On HILTI exp14 the x86_64 wheel writes the same map bytes as the source install below.
From source (Ubuntu packages, builds the C++ core):
sudo apt install build-essential cmake libeigen3-dev libtbb-dev robin-map-dev \
libpcl-dev libg2o-dev libzstd-dev python3-venv # tested on Ubuntu 24.04
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
python3 -m venv .venv && . .venv/bin/activate
pip install ./lidarslam_core # Python >= 3.10; downloads Sophus while building
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
python -m lidarslam inspect /path/to/rosbag2 # topics and message types
python -m lidarslam odometry /path/to/rosbag2 --params my_rko_lio.yaml --out odom/
python -m lidarslam map /path/to/rosbag2 --odometry-params my_rko_lio.yaml \
--backend-params lidarslam/param/lidarslam.yaml --out map/ # both, in one pass
python -m lidarslam backend /path/to/backend_input \
--params lidarslam/param/lidarslam_mid360_rko_graph_walking.yaml --out map/ \
-p "extrinsic_lidar2base_quat_xyzw_xyz:=[0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0]"
--params takes the same parameter file as the ROS 2 RKO-LIO node (ros__parameters layout), with imu_topic, lidar_topic, base_frame and both extrinsic_*2base_quat_xyzw_xyz set. On HILTI exp14 the trajectory is byte-identical to the ROS 2 offline node. Visual and radar fusion still need ROS 2. A lidar_topic of Velodyne packets (velodyne_msgs/msg/VelodyneScan) is decoded as velodyne_transform_node does; set velodyne.model (VLP16 by default, 32C, 32E, VLS128) or velodyne.calibration. The decoder’s per-point time counts from the scan stamp, so lidar_timestamps.force_relative is set for packet input unless the parameter file sets lidar_timestamps.force_relative or force_absolute.
File truncated at 100 lines see the full file
CONTRIBUTING
Contributing
Thanks for contributing to lidarslam_ros2.
This repository is trying to be a practical default for ROS 2 LiDAR SLAM and Autoware pointcloud-map generation. Contributions are most useful when they are easy to reproduce, easy to compare, and clearly scoped.
Participation is governed by the Code of Conduct. The Governance, Support, and Security policies explain decisions, help routes, and private vulnerability reporting.
What To Send
Useful contributions include:
- bug fixes in the default permissive workflow
- Autoware pointcloud-map integration fixes
- benchmark results with reproducible commands and artifacts
- parameter improvements backed by logs and trajectory metrics
- documentation improvements that reduce setup time
Default Workflow Policy
The default and recommended workflow in this repository is permissive-license only. Contributions that change the default path should preserve that property.
Current default path:
RKO-LIO + graph_based_slam- local Scan Context implementation
- Autoware-compatible pointcloud map output
Research frontends with other licenses can still be discussed, but they should not silently become the default path.
Repository Layout
Keep the repository root limited to project metadata and primary entry-point
documents. Place commands under scripts/, offline libraries under tools/,
and small research outputs under docs/research/artifacts/. Do not commit
colcon manifests or other generated build products. See the
repository layout guide for the complete map.
Autoware Naming And Trademark Guidance
Keep Autoware references descriptive.
Preferred wording:
Autoware-compatible pointcloud mappointcloud-map workflow for Autowareworks with Autowarebuilt on Autoware
Avoid branding this repository or a derived product as if it were an official Autoware product or a Foundation-approved distribution.
Avoid wording such as:
-
Autoware-readyas a product tag line official AutowareAutoware <product-name>certified by Autowareendorsed by the Autoware Foundation
If in doubt, prefer compatibility language over product-name language.
Before Opening An Issue
Please collect the smallest reproducible case you can. Use the structured bug, feature, sensor-support, benchmark, or Autoware issue form that best matches the request. Usage questions must include the diagnostic bundle listed in SUPPORT.md.
If you completed a first map from the public docs without live maintainer guidance, use the independent first-map validation form. Passing reports may count toward the v1.0 three-user gate; failed attempts are recorded as onboarding findings and are just as valuable.
For bug reports, keep ordinary doctor <bag> --json output local because it
contains the bag path and local commands. Instead run and review:
lidarslam-map doctor <rosbag2_dir> --public-json
Paste that complete public-doctor-evidence-v1 path-free JSON, a redacted
command shape, expected/observed behavior, and either one reviewed support ZIP
from an existing session or an explicit no-session/no-ZIP statement with the
first finding code. Never attach a bag, map, trajectory, raw log/data,
parameter file, terminal history, or private-site image.
For Autoware-related reports, include:
- projector type and whether an origin exists, with every coordinate and
MGRS/grid identifier and precise origin value replaced by
REDACTED - the non-geometry verifier findings, with private paths and precise locations
File truncated at 100 lines see the full file
Repository Summary
| Description | |
| Checkout URI | https://github.com/rsasaki0109/lidarslam_ros2.git |
| VCS Type | git |
| VCS Version | develop |
| Last Updated | 2026-11-18 |
| Dev Status | UNKNOWN |
| Released | UNRELEASED |
| Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
| Name | Version |
|---|---|
| lidarslam_registration_plugin_template | 0.1.0 |
| graph_based_slam | 0.13.0 |
| lidarslam | 0.13.0 |
| lidarslam_default_plugins | 0.6.0 |
| lidarslam_fake_registration_plugins | 0.6.0 |
| lidarslam_msgs | 0.13.0 |
| lidarslam_plugin_interfaces | 0.6.0 |
| lidarslam_registration_loader | 0.6.0 |
| scanmatcher | 0.13.0 |
README
lidar_slam
Turn a rosbag into a map you can actually drive on. LiDAR SLAM that writes an Autoware-compatible map bundle: pointcloud_map/, map_projector_info.yaml and lanelet2. It runs as ROS 2 packages (Humble, Jazzy) or without ROS 2 from pip install lidarslam. RKO-LIO (MIT) + graph_based_slam (BSD-2), no GPL on the default workflow. Try it in your browser · Open in Colab · 日本語クイックスタート · release notes v0.13.0 · v0.12.0
Documentation · Supported inputs and outputs · Workflow and benchmark comparison
Outdoor walk, APE 0.55 m (Koide, CC BY 4.0) · camera-coloured park (RTK-SLAM, CC BY 4.0) · stairs, ATE 0.24 m on development data · held-out metro tunnel, 0.38 m like BIEVR-LIO and FAST-LIO2 (GEODE) · three separate walks joined into one map with no position hint (Oxford Spires, CC BY-NC-SA 4.0). How these were made.
Quickstart
Choose your shortest path
| Goal | Start here | Safety and cost boundary |
|---|---|---|
| See a verified map, no build | Default if unsure: Docker demo | Stable v0.12.0-humble; needs Docker; host writes stay in ./lidarslam_output. |
| Map my own rosbag |
Own-bag route: lidarslam-map doctor /path/to/rosbag2
|
Read-only diagnosis first; then lidarslam-map start /path/to/rosbag2 writes a new output. |
| Build from source or contribute |
Source quickstart: bash scripts/source_quickstart.sh --dry-run
|
Release v0.12.0; needs ROS 2, 8 GiB, and roughly 30 minutes. |
| Map a bag without ROS 2 (preview) |
pip install: pip install lidarslam-*.whl (prebuilt) or pip install ./lidarslam_core, then lidarslam-map start /path/to/rosbag2
|
No ROS 2; the prebuilt wheel needs no apt packages (Linux x86_64/aarch64, Python 3.10-3.13). RKO-LIO profiles; with --lidarslam-param lidarslam_rtk_gnss.yaml the map is anchored to the bag’s RTK GNSS (/gnss/fix); Velodyne packet bags (VelodyneScan + Imu) with --engine core. The classic GNSS and packet profiles need ROS 2. |
Try it with Docker (one command, no build)
docker run --rm -e LIDARSLAM_HOST_UID="$(id -u)" -e LIDARSLAM_HOST_GID="$(id -g)" \
-v "$PWD/lidarslam_output:/lidarslam_ws/output" \
ghcr.io/rsasaki0109/lidar_slam_ros2:v0.12.0-humble
The repository was renamed from lidar_slam_ros2 to lidar_slam; the v0.12.0 images keep their published name ghcr.io/rsasaki0109/lidar_slam_ros2, and old GitHub links redirect.
The 517 MB MID-360 demo writes lidarslam_output/mid360_demo/ as your user. Other platforms: Getting Started.
Map your own bag (one command after install)
lidarslam-map start /path/to/rosbag2
Run lidarslam-map with no arguments for a guided start, or lidarslam-map doctor first: it uses no network and writes no files. See supported inputs.
Build + verified demo from source (one helper)
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
bash scripts/source_quickstart.sh
The helper detects Humble/Jazzy, installs the dependencies, builds the six maintained packages and runs the verified demo (--dry-run, --build-only). It prints a lidarslam-map path that auto-activates this build. Needs ROS 2, 8 GiB and about 30 minutes. Before handoff: python3 scripts/check_first_map_verification_package.py --json, continue only on READY.
Without ROS 2 (pip, preview)
ROS 2 is becoming one option rather than a requirement. The pip package installs the lidarslam-map command with the RKO-LIO odometry and the graph_based_slam backend (loop closure, pose graph, refinement, Autoware map bundle) inside, and reads rosbag2 (MCAP, SQLite3) and ROS 1 bags without ROS 2 (roadmap).
Prebuilt wheel (no apt packages, no compiler). The wheels workflow builds manylinux wheels (glibc 2.28+, x86_64 and aarch64, Python 3.10-3.13) that bundle PCL, g2o and the other C++ libraries. From the first release published to PyPI on, pip install lidarslam installs them. Until then, open the latest successful run on develop, download lidarslam-wheels-x86_64 (or -aarch64; GitHub sign-in needed), unzip it and install the wheel for your Python:
python3 -m venv .venv && . .venv/bin/activate
pip install lidarslam-*-cp312-cp312-manylinux_2_28_x86_64.whl # your cpXY and arch
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
On HILTI exp14 the x86_64 wheel writes the same map bytes as the source install below.
From source (Ubuntu packages, builds the C++ core):
sudo apt install build-essential cmake libeigen3-dev libtbb-dev robin-map-dev \
libpcl-dev libg2o-dev libzstd-dev python3-venv # tested on Ubuntu 24.04
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
python3 -m venv .venv && . .venv/bin/activate
pip install ./lidarslam_core # Python >= 3.10; downloads Sophus while building
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
python -m lidarslam inspect /path/to/rosbag2 # topics and message types
python -m lidarslam odometry /path/to/rosbag2 --params my_rko_lio.yaml --out odom/
python -m lidarslam map /path/to/rosbag2 --odometry-params my_rko_lio.yaml \
--backend-params lidarslam/param/lidarslam.yaml --out map/ # both, in one pass
python -m lidarslam backend /path/to/backend_input \
--params lidarslam/param/lidarslam_mid360_rko_graph_walking.yaml --out map/ \
-p "extrinsic_lidar2base_quat_xyzw_xyz:=[0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0]"
--params takes the same parameter file as the ROS 2 RKO-LIO node (ros__parameters layout), with imu_topic, lidar_topic, base_frame and both extrinsic_*2base_quat_xyzw_xyz set. On HILTI exp14 the trajectory is byte-identical to the ROS 2 offline node. Visual and radar fusion still need ROS 2. A lidar_topic of Velodyne packets (velodyne_msgs/msg/VelodyneScan) is decoded as velodyne_transform_node does; set velodyne.model (VLP16 by default, 32C, 32E, VLS128) or velodyne.calibration. The decoder’s per-point time counts from the scan stamp, so lidar_timestamps.force_relative is set for packet input unless the parameter file sets lidar_timestamps.force_relative or force_absolute.
File truncated at 100 lines see the full file
CONTRIBUTING
Contributing
Thanks for contributing to lidarslam_ros2.
This repository is trying to be a practical default for ROS 2 LiDAR SLAM and Autoware pointcloud-map generation. Contributions are most useful when they are easy to reproduce, easy to compare, and clearly scoped.
Participation is governed by the Code of Conduct. The Governance, Support, and Security policies explain decisions, help routes, and private vulnerability reporting.
What To Send
Useful contributions include:
- bug fixes in the default permissive workflow
- Autoware pointcloud-map integration fixes
- benchmark results with reproducible commands and artifacts
- parameter improvements backed by logs and trajectory metrics
- documentation improvements that reduce setup time
Default Workflow Policy
The default and recommended workflow in this repository is permissive-license only. Contributions that change the default path should preserve that property.
Current default path:
RKO-LIO + graph_based_slam- local Scan Context implementation
- Autoware-compatible pointcloud map output
Research frontends with other licenses can still be discussed, but they should not silently become the default path.
Repository Layout
Keep the repository root limited to project metadata and primary entry-point
documents. Place commands under scripts/, offline libraries under tools/,
and small research outputs under docs/research/artifacts/. Do not commit
colcon manifests or other generated build products. See the
repository layout guide for the complete map.
Autoware Naming And Trademark Guidance
Keep Autoware references descriptive.
Preferred wording:
Autoware-compatible pointcloud mappointcloud-map workflow for Autowareworks with Autowarebuilt on Autoware
Avoid branding this repository or a derived product as if it were an official Autoware product or a Foundation-approved distribution.
Avoid wording such as:
-
Autoware-readyas a product tag line official AutowareAutoware <product-name>certified by Autowareendorsed by the Autoware Foundation
If in doubt, prefer compatibility language over product-name language.
Before Opening An Issue
Please collect the smallest reproducible case you can. Use the structured bug, feature, sensor-support, benchmark, or Autoware issue form that best matches the request. Usage questions must include the diagnostic bundle listed in SUPPORT.md.
If you completed a first map from the public docs without live maintainer guidance, use the independent first-map validation form. Passing reports may count toward the v1.0 three-user gate; failed attempts are recorded as onboarding findings and are just as valuable.
For bug reports, keep ordinary doctor <bag> --json output local because it
contains the bag path and local commands. Instead run and review:
lidarslam-map doctor <rosbag2_dir> --public-json
Paste that complete public-doctor-evidence-v1 path-free JSON, a redacted
command shape, expected/observed behavior, and either one reviewed support ZIP
from an existing session or an explicit no-session/no-ZIP statement with the
first finding code. Never attach a bag, map, trajectory, raw log/data,
parameter file, terminal history, or private-site image.
For Autoware-related reports, include:
- projector type and whether an origin exists, with every coordinate and
MGRS/grid identifier and precise origin value replaced by
REDACTED - the non-geometry verifier findings, with private paths and precise locations
File truncated at 100 lines see the full file
Repository Summary
| Description | |
| Checkout URI | https://github.com/rsasaki0109/lidarslam_ros2.git |
| VCS Type | git |
| VCS Version | develop |
| Last Updated | 2026-11-18 |
| Dev Status | UNKNOWN |
| Released | UNRELEASED |
| Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
| Name | Version |
|---|---|
| lidarslam_registration_plugin_template | 0.1.0 |
| graph_based_slam | 0.13.0 |
| lidarslam | 0.13.0 |
| lidarslam_default_plugins | 0.6.0 |
| lidarslam_fake_registration_plugins | 0.6.0 |
| lidarslam_msgs | 0.13.0 |
| lidarslam_plugin_interfaces | 0.6.0 |
| lidarslam_registration_loader | 0.6.0 |
| scanmatcher | 0.13.0 |
README
lidar_slam
Turn a rosbag into a map you can actually drive on. LiDAR SLAM that writes an Autoware-compatible map bundle: pointcloud_map/, map_projector_info.yaml and lanelet2. It runs as ROS 2 packages (Humble, Jazzy) or without ROS 2 from pip install lidarslam. RKO-LIO (MIT) + graph_based_slam (BSD-2), no GPL on the default workflow. Try it in your browser · Open in Colab · 日本語クイックスタート · release notes v0.13.0 · v0.12.0
Documentation · Supported inputs and outputs · Workflow and benchmark comparison
Outdoor walk, APE 0.55 m (Koide, CC BY 4.0) · camera-coloured park (RTK-SLAM, CC BY 4.0) · stairs, ATE 0.24 m on development data · held-out metro tunnel, 0.38 m like BIEVR-LIO and FAST-LIO2 (GEODE) · three separate walks joined into one map with no position hint (Oxford Spires, CC BY-NC-SA 4.0). How these were made.
Quickstart
Choose your shortest path
| Goal | Start here | Safety and cost boundary |
|---|---|---|
| See a verified map, no build | Default if unsure: Docker demo | Stable v0.12.0-humble; needs Docker; host writes stay in ./lidarslam_output. |
| Map my own rosbag |
Own-bag route: lidarslam-map doctor /path/to/rosbag2
|
Read-only diagnosis first; then lidarslam-map start /path/to/rosbag2 writes a new output. |
| Build from source or contribute |
Source quickstart: bash scripts/source_quickstart.sh --dry-run
|
Release v0.12.0; needs ROS 2, 8 GiB, and roughly 30 minutes. |
| Map a bag without ROS 2 (preview) |
pip install: pip install lidarslam-*.whl (prebuilt) or pip install ./lidarslam_core, then lidarslam-map start /path/to/rosbag2
|
No ROS 2; the prebuilt wheel needs no apt packages (Linux x86_64/aarch64, Python 3.10-3.13). RKO-LIO profiles; with --lidarslam-param lidarslam_rtk_gnss.yaml the map is anchored to the bag’s RTK GNSS (/gnss/fix); Velodyne packet bags (VelodyneScan + Imu) with --engine core. The classic GNSS and packet profiles need ROS 2. |
Try it with Docker (one command, no build)
docker run --rm -e LIDARSLAM_HOST_UID="$(id -u)" -e LIDARSLAM_HOST_GID="$(id -g)" \
-v "$PWD/lidarslam_output:/lidarslam_ws/output" \
ghcr.io/rsasaki0109/lidar_slam_ros2:v0.12.0-humble
The repository was renamed from lidar_slam_ros2 to lidar_slam; the v0.12.0 images keep their published name ghcr.io/rsasaki0109/lidar_slam_ros2, and old GitHub links redirect.
The 517 MB MID-360 demo writes lidarslam_output/mid360_demo/ as your user. Other platforms: Getting Started.
Map your own bag (one command after install)
lidarslam-map start /path/to/rosbag2
Run lidarslam-map with no arguments for a guided start, or lidarslam-map doctor first: it uses no network and writes no files. See supported inputs.
Build + verified demo from source (one helper)
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
bash scripts/source_quickstart.sh
The helper detects Humble/Jazzy, installs the dependencies, builds the six maintained packages and runs the verified demo (--dry-run, --build-only). It prints a lidarslam-map path that auto-activates this build. Needs ROS 2, 8 GiB and about 30 minutes. Before handoff: python3 scripts/check_first_map_verification_package.py --json, continue only on READY.
Without ROS 2 (pip, preview)
ROS 2 is becoming one option rather than a requirement. The pip package installs the lidarslam-map command with the RKO-LIO odometry and the graph_based_slam backend (loop closure, pose graph, refinement, Autoware map bundle) inside, and reads rosbag2 (MCAP, SQLite3) and ROS 1 bags without ROS 2 (roadmap).
Prebuilt wheel (no apt packages, no compiler). The wheels workflow builds manylinux wheels (glibc 2.28+, x86_64 and aarch64, Python 3.10-3.13) that bundle PCL, g2o and the other C++ libraries. From the first release published to PyPI on, pip install lidarslam installs them. Until then, open the latest successful run on develop, download lidarslam-wheels-x86_64 (or -aarch64; GitHub sign-in needed), unzip it and install the wheel for your Python:
python3 -m venv .venv && . .venv/bin/activate
pip install lidarslam-*-cp312-cp312-manylinux_2_28_x86_64.whl # your cpXY and arch
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
On HILTI exp14 the x86_64 wheel writes the same map bytes as the source install below.
From source (Ubuntu packages, builds the C++ core):
sudo apt install build-essential cmake libeigen3-dev libtbb-dev robin-map-dev \
libpcl-dev libg2o-dev libzstd-dev python3-venv # tested on Ubuntu 24.04
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
python3 -m venv .venv && . .venv/bin/activate
pip install ./lidarslam_core # Python >= 3.10; downloads Sophus while building
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
python -m lidarslam inspect /path/to/rosbag2 # topics and message types
python -m lidarslam odometry /path/to/rosbag2 --params my_rko_lio.yaml --out odom/
python -m lidarslam map /path/to/rosbag2 --odometry-params my_rko_lio.yaml \
--backend-params lidarslam/param/lidarslam.yaml --out map/ # both, in one pass
python -m lidarslam backend /path/to/backend_input \
--params lidarslam/param/lidarslam_mid360_rko_graph_walking.yaml --out map/ \
-p "extrinsic_lidar2base_quat_xyzw_xyz:=[0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0]"
--params takes the same parameter file as the ROS 2 RKO-LIO node (ros__parameters layout), with imu_topic, lidar_topic, base_frame and both extrinsic_*2base_quat_xyzw_xyz set. On HILTI exp14 the trajectory is byte-identical to the ROS 2 offline node. Visual and radar fusion still need ROS 2. A lidar_topic of Velodyne packets (velodyne_msgs/msg/VelodyneScan) is decoded as velodyne_transform_node does; set velodyne.model (VLP16 by default, 32C, 32E, VLS128) or velodyne.calibration. The decoder’s per-point time counts from the scan stamp, so lidar_timestamps.force_relative is set for packet input unless the parameter file sets lidar_timestamps.force_relative or force_absolute.
File truncated at 100 lines see the full file
CONTRIBUTING
Contributing
Thanks for contributing to lidarslam_ros2.
This repository is trying to be a practical default for ROS 2 LiDAR SLAM and Autoware pointcloud-map generation. Contributions are most useful when they are easy to reproduce, easy to compare, and clearly scoped.
Participation is governed by the Code of Conduct. The Governance, Support, and Security policies explain decisions, help routes, and private vulnerability reporting.
What To Send
Useful contributions include:
- bug fixes in the default permissive workflow
- Autoware pointcloud-map integration fixes
- benchmark results with reproducible commands and artifacts
- parameter improvements backed by logs and trajectory metrics
- documentation improvements that reduce setup time
Default Workflow Policy
The default and recommended workflow in this repository is permissive-license only. Contributions that change the default path should preserve that property.
Current default path:
RKO-LIO + graph_based_slam- local Scan Context implementation
- Autoware-compatible pointcloud map output
Research frontends with other licenses can still be discussed, but they should not silently become the default path.
Repository Layout
Keep the repository root limited to project metadata and primary entry-point
documents. Place commands under scripts/, offline libraries under tools/,
and small research outputs under docs/research/artifacts/. Do not commit
colcon manifests or other generated build products. See the
repository layout guide for the complete map.
Autoware Naming And Trademark Guidance
Keep Autoware references descriptive.
Preferred wording:
Autoware-compatible pointcloud mappointcloud-map workflow for Autowareworks with Autowarebuilt on Autoware
Avoid branding this repository or a derived product as if it were an official Autoware product or a Foundation-approved distribution.
Avoid wording such as:
-
Autoware-readyas a product tag line official AutowareAutoware <product-name>certified by Autowareendorsed by the Autoware Foundation
If in doubt, prefer compatibility language over product-name language.
Before Opening An Issue
Please collect the smallest reproducible case you can. Use the structured bug, feature, sensor-support, benchmark, or Autoware issue form that best matches the request. Usage questions must include the diagnostic bundle listed in SUPPORT.md.
If you completed a first map from the public docs without live maintainer guidance, use the independent first-map validation form. Passing reports may count toward the v1.0 three-user gate; failed attempts are recorded as onboarding findings and are just as valuable.
For bug reports, keep ordinary doctor <bag> --json output local because it
contains the bag path and local commands. Instead run and review:
lidarslam-map doctor <rosbag2_dir> --public-json
Paste that complete public-doctor-evidence-v1 path-free JSON, a redacted
command shape, expected/observed behavior, and either one reviewed support ZIP
from an existing session or an explicit no-session/no-ZIP statement with the
first finding code. Never attach a bag, map, trajectory, raw log/data,
parameter file, terminal history, or private-site image.
For Autoware-related reports, include:
- projector type and whether an origin exists, with every coordinate and
MGRS/grid identifier and precise origin value replaced by
REDACTED - the non-geometry verifier findings, with private paths and precise locations
File truncated at 100 lines see the full file
Repository Summary
| Description | |
| Checkout URI | https://github.com/rsasaki0109/lidarslam_ros2.git |
| VCS Type | git |
| VCS Version | develop |
| Last Updated | 2026-11-18 |
| Dev Status | UNKNOWN |
| Released | UNRELEASED |
| Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
| Name | Version |
|---|---|
| lidarslam_registration_plugin_template | 0.1.0 |
| graph_based_slam | 0.13.0 |
| lidarslam | 0.13.0 |
| lidarslam_default_plugins | 0.6.0 |
| lidarslam_fake_registration_plugins | 0.6.0 |
| lidarslam_msgs | 0.13.0 |
| lidarslam_plugin_interfaces | 0.6.0 |
| lidarslam_registration_loader | 0.6.0 |
| scanmatcher | 0.13.0 |
README
lidar_slam
Turn a rosbag into a map you can actually drive on. LiDAR SLAM that writes an Autoware-compatible map bundle: pointcloud_map/, map_projector_info.yaml and lanelet2. It runs as ROS 2 packages (Humble, Jazzy) or without ROS 2 from pip install lidarslam. RKO-LIO (MIT) + graph_based_slam (BSD-2), no GPL on the default workflow. Try it in your browser · Open in Colab · 日本語クイックスタート · release notes v0.13.0 · v0.12.0
Documentation · Supported inputs and outputs · Workflow and benchmark comparison
Outdoor walk, APE 0.55 m (Koide, CC BY 4.0) · camera-coloured park (RTK-SLAM, CC BY 4.0) · stairs, ATE 0.24 m on development data · held-out metro tunnel, 0.38 m like BIEVR-LIO and FAST-LIO2 (GEODE) · three separate walks joined into one map with no position hint (Oxford Spires, CC BY-NC-SA 4.0). How these were made.
Quickstart
Choose your shortest path
| Goal | Start here | Safety and cost boundary |
|---|---|---|
| See a verified map, no build | Default if unsure: Docker demo | Stable v0.12.0-humble; needs Docker; host writes stay in ./lidarslam_output. |
| Map my own rosbag |
Own-bag route: lidarslam-map doctor /path/to/rosbag2
|
Read-only diagnosis first; then lidarslam-map start /path/to/rosbag2 writes a new output. |
| Build from source or contribute |
Source quickstart: bash scripts/source_quickstart.sh --dry-run
|
Release v0.12.0; needs ROS 2, 8 GiB, and roughly 30 minutes. |
| Map a bag without ROS 2 (preview) |
pip install: pip install lidarslam-*.whl (prebuilt) or pip install ./lidarslam_core, then lidarslam-map start /path/to/rosbag2
|
No ROS 2; the prebuilt wheel needs no apt packages (Linux x86_64/aarch64, Python 3.10-3.13). RKO-LIO profiles; with --lidarslam-param lidarslam_rtk_gnss.yaml the map is anchored to the bag’s RTK GNSS (/gnss/fix); Velodyne packet bags (VelodyneScan + Imu) with --engine core. The classic GNSS and packet profiles need ROS 2. |
Try it with Docker (one command, no build)
docker run --rm -e LIDARSLAM_HOST_UID="$(id -u)" -e LIDARSLAM_HOST_GID="$(id -g)" \
-v "$PWD/lidarslam_output:/lidarslam_ws/output" \
ghcr.io/rsasaki0109/lidar_slam_ros2:v0.12.0-humble
The repository was renamed from lidar_slam_ros2 to lidar_slam; the v0.12.0 images keep their published name ghcr.io/rsasaki0109/lidar_slam_ros2, and old GitHub links redirect.
The 517 MB MID-360 demo writes lidarslam_output/mid360_demo/ as your user. Other platforms: Getting Started.
Map your own bag (one command after install)
lidarslam-map start /path/to/rosbag2
Run lidarslam-map with no arguments for a guided start, or lidarslam-map doctor first: it uses no network and writes no files. See supported inputs.
Build + verified demo from source (one helper)
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
bash scripts/source_quickstart.sh
The helper detects Humble/Jazzy, installs the dependencies, builds the six maintained packages and runs the verified demo (--dry-run, --build-only). It prints a lidarslam-map path that auto-activates this build. Needs ROS 2, 8 GiB and about 30 minutes. Before handoff: python3 scripts/check_first_map_verification_package.py --json, continue only on READY.
Without ROS 2 (pip, preview)
ROS 2 is becoming one option rather than a requirement. The pip package installs the lidarslam-map command with the RKO-LIO odometry and the graph_based_slam backend (loop closure, pose graph, refinement, Autoware map bundle) inside, and reads rosbag2 (MCAP, SQLite3) and ROS 1 bags without ROS 2 (roadmap).
Prebuilt wheel (no apt packages, no compiler). The wheels workflow builds manylinux wheels (glibc 2.28+, x86_64 and aarch64, Python 3.10-3.13) that bundle PCL, g2o and the other C++ libraries. From the first release published to PyPI on, pip install lidarslam installs them. Until then, open the latest successful run on develop, download lidarslam-wheels-x86_64 (or -aarch64; GitHub sign-in needed), unzip it and install the wheel for your Python:
python3 -m venv .venv && . .venv/bin/activate
pip install lidarslam-*-cp312-cp312-manylinux_2_28_x86_64.whl # your cpXY and arch
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
On HILTI exp14 the x86_64 wheel writes the same map bytes as the source install below.
From source (Ubuntu packages, builds the C++ core):
sudo apt install build-essential cmake libeigen3-dev libtbb-dev robin-map-dev \
libpcl-dev libg2o-dev libzstd-dev python3-venv # tested on Ubuntu 24.04
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
python3 -m venv .venv && . .venv/bin/activate
pip install ./lidarslam_core # Python >= 3.10; downloads Sophus while building
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
python -m lidarslam inspect /path/to/rosbag2 # topics and message types
python -m lidarslam odometry /path/to/rosbag2 --params my_rko_lio.yaml --out odom/
python -m lidarslam map /path/to/rosbag2 --odometry-params my_rko_lio.yaml \
--backend-params lidarslam/param/lidarslam.yaml --out map/ # both, in one pass
python -m lidarslam backend /path/to/backend_input \
--params lidarslam/param/lidarslam_mid360_rko_graph_walking.yaml --out map/ \
-p "extrinsic_lidar2base_quat_xyzw_xyz:=[0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0]"
--params takes the same parameter file as the ROS 2 RKO-LIO node (ros__parameters layout), with imu_topic, lidar_topic, base_frame and both extrinsic_*2base_quat_xyzw_xyz set. On HILTI exp14 the trajectory is byte-identical to the ROS 2 offline node. Visual and radar fusion still need ROS 2. A lidar_topic of Velodyne packets (velodyne_msgs/msg/VelodyneScan) is decoded as velodyne_transform_node does; set velodyne.model (VLP16 by default, 32C, 32E, VLS128) or velodyne.calibration. The decoder’s per-point time counts from the scan stamp, so lidar_timestamps.force_relative is set for packet input unless the parameter file sets lidar_timestamps.force_relative or force_absolute.
File truncated at 100 lines see the full file
CONTRIBUTING
Contributing
Thanks for contributing to lidarslam_ros2.
This repository is trying to be a practical default for ROS 2 LiDAR SLAM and Autoware pointcloud-map generation. Contributions are most useful when they are easy to reproduce, easy to compare, and clearly scoped.
Participation is governed by the Code of Conduct. The Governance, Support, and Security policies explain decisions, help routes, and private vulnerability reporting.
What To Send
Useful contributions include:
- bug fixes in the default permissive workflow
- Autoware pointcloud-map integration fixes
- benchmark results with reproducible commands and artifacts
- parameter improvements backed by logs and trajectory metrics
- documentation improvements that reduce setup time
Default Workflow Policy
The default and recommended workflow in this repository is permissive-license only. Contributions that change the default path should preserve that property.
Current default path:
RKO-LIO + graph_based_slam- local Scan Context implementation
- Autoware-compatible pointcloud map output
Research frontends with other licenses can still be discussed, but they should not silently become the default path.
Repository Layout
Keep the repository root limited to project metadata and primary entry-point
documents. Place commands under scripts/, offline libraries under tools/,
and small research outputs under docs/research/artifacts/. Do not commit
colcon manifests or other generated build products. See the
repository layout guide for the complete map.
Autoware Naming And Trademark Guidance
Keep Autoware references descriptive.
Preferred wording:
Autoware-compatible pointcloud mappointcloud-map workflow for Autowareworks with Autowarebuilt on Autoware
Avoid branding this repository or a derived product as if it were an official Autoware product or a Foundation-approved distribution.
Avoid wording such as:
-
Autoware-readyas a product tag line official AutowareAutoware <product-name>certified by Autowareendorsed by the Autoware Foundation
If in doubt, prefer compatibility language over product-name language.
Before Opening An Issue
Please collect the smallest reproducible case you can. Use the structured bug, feature, sensor-support, benchmark, or Autoware issue form that best matches the request. Usage questions must include the diagnostic bundle listed in SUPPORT.md.
If you completed a first map from the public docs without live maintainer guidance, use the independent first-map validation form. Passing reports may count toward the v1.0 three-user gate; failed attempts are recorded as onboarding findings and are just as valuable.
For bug reports, keep ordinary doctor <bag> --json output local because it
contains the bag path and local commands. Instead run and review:
lidarslam-map doctor <rosbag2_dir> --public-json
Paste that complete public-doctor-evidence-v1 path-free JSON, a redacted
command shape, expected/observed behavior, and either one reviewed support ZIP
from an existing session or an explicit no-session/no-ZIP statement with the
first finding code. Never attach a bag, map, trajectory, raw log/data,
parameter file, terminal history, or private-site image.
For Autoware-related reports, include:
- projector type and whether an origin exists, with every coordinate and
MGRS/grid identifier and precise origin value replaced by
REDACTED - the non-geometry verifier findings, with private paths and precise locations
File truncated at 100 lines see the full file
Repository Summary
| Description | |
| Checkout URI | https://github.com/rsasaki0109/lidarslam_ros2.git |
| VCS Type | git |
| VCS Version | develop |
| Last Updated | 2026-11-18 |
| Dev Status | UNKNOWN |
| Released | UNRELEASED |
| Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
| Name | Version |
|---|---|
| lidarslam_registration_plugin_template | 0.1.0 |
| graph_based_slam | 0.13.0 |
| lidarslam | 0.13.0 |
| lidarslam_default_plugins | 0.6.0 |
| lidarslam_fake_registration_plugins | 0.6.0 |
| lidarslam_msgs | 0.13.0 |
| lidarslam_plugin_interfaces | 0.6.0 |
| lidarslam_registration_loader | 0.6.0 |
| scanmatcher | 0.13.0 |
README
lidar_slam
Turn a rosbag into a map you can actually drive on. LiDAR SLAM that writes an Autoware-compatible map bundle: pointcloud_map/, map_projector_info.yaml and lanelet2. It runs as ROS 2 packages (Humble, Jazzy) or without ROS 2 from pip install lidarslam. RKO-LIO (MIT) + graph_based_slam (BSD-2), no GPL on the default workflow. Try it in your browser · Open in Colab · 日本語クイックスタート · release notes v0.13.0 · v0.12.0
Documentation · Supported inputs and outputs · Workflow and benchmark comparison
Outdoor walk, APE 0.55 m (Koide, CC BY 4.0) · camera-coloured park (RTK-SLAM, CC BY 4.0) · stairs, ATE 0.24 m on development data · held-out metro tunnel, 0.38 m like BIEVR-LIO and FAST-LIO2 (GEODE) · three separate walks joined into one map with no position hint (Oxford Spires, CC BY-NC-SA 4.0). How these were made.
Quickstart
Choose your shortest path
| Goal | Start here | Safety and cost boundary |
|---|---|---|
| See a verified map, no build | Default if unsure: Docker demo | Stable v0.12.0-humble; needs Docker; host writes stay in ./lidarslam_output. |
| Map my own rosbag |
Own-bag route: lidarslam-map doctor /path/to/rosbag2
|
Read-only diagnosis first; then lidarslam-map start /path/to/rosbag2 writes a new output. |
| Build from source or contribute |
Source quickstart: bash scripts/source_quickstart.sh --dry-run
|
Release v0.12.0; needs ROS 2, 8 GiB, and roughly 30 minutes. |
| Map a bag without ROS 2 (preview) |
pip install: pip install lidarslam-*.whl (prebuilt) or pip install ./lidarslam_core, then lidarslam-map start /path/to/rosbag2
|
No ROS 2; the prebuilt wheel needs no apt packages (Linux x86_64/aarch64, Python 3.10-3.13). RKO-LIO profiles; with --lidarslam-param lidarslam_rtk_gnss.yaml the map is anchored to the bag’s RTK GNSS (/gnss/fix); Velodyne packet bags (VelodyneScan + Imu) with --engine core. The classic GNSS and packet profiles need ROS 2. |
Try it with Docker (one command, no build)
docker run --rm -e LIDARSLAM_HOST_UID="$(id -u)" -e LIDARSLAM_HOST_GID="$(id -g)" \
-v "$PWD/lidarslam_output:/lidarslam_ws/output" \
ghcr.io/rsasaki0109/lidar_slam_ros2:v0.12.0-humble
The repository was renamed from lidar_slam_ros2 to lidar_slam; the v0.12.0 images keep their published name ghcr.io/rsasaki0109/lidar_slam_ros2, and old GitHub links redirect.
The 517 MB MID-360 demo writes lidarslam_output/mid360_demo/ as your user. Other platforms: Getting Started.
Map your own bag (one command after install)
lidarslam-map start /path/to/rosbag2
Run lidarslam-map with no arguments for a guided start, or lidarslam-map doctor first: it uses no network and writes no files. See supported inputs.
Build + verified demo from source (one helper)
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
bash scripts/source_quickstart.sh
The helper detects Humble/Jazzy, installs the dependencies, builds the six maintained packages and runs the verified demo (--dry-run, --build-only). It prints a lidarslam-map path that auto-activates this build. Needs ROS 2, 8 GiB and about 30 minutes. Before handoff: python3 scripts/check_first_map_verification_package.py --json, continue only on READY.
Without ROS 2 (pip, preview)
ROS 2 is becoming one option rather than a requirement. The pip package installs the lidarslam-map command with the RKO-LIO odometry and the graph_based_slam backend (loop closure, pose graph, refinement, Autoware map bundle) inside, and reads rosbag2 (MCAP, SQLite3) and ROS 1 bags without ROS 2 (roadmap).
Prebuilt wheel (no apt packages, no compiler). The wheels workflow builds manylinux wheels (glibc 2.28+, x86_64 and aarch64, Python 3.10-3.13) that bundle PCL, g2o and the other C++ libraries. From the first release published to PyPI on, pip install lidarslam installs them. Until then, open the latest successful run on develop, download lidarslam-wheels-x86_64 (or -aarch64; GitHub sign-in needed), unzip it and install the wheel for your Python:
python3 -m venv .venv && . .venv/bin/activate
pip install lidarslam-*-cp312-cp312-manylinux_2_28_x86_64.whl # your cpXY and arch
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
On HILTI exp14 the x86_64 wheel writes the same map bytes as the source install below.
From source (Ubuntu packages, builds the C++ core):
sudo apt install build-essential cmake libeigen3-dev libtbb-dev robin-map-dev \
libpcl-dev libg2o-dev libzstd-dev python3-venv # tested on Ubuntu 24.04
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
python3 -m venv .venv && . .venv/bin/activate
pip install ./lidarslam_core # Python >= 3.10; downloads Sophus while building
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
python -m lidarslam inspect /path/to/rosbag2 # topics and message types
python -m lidarslam odometry /path/to/rosbag2 --params my_rko_lio.yaml --out odom/
python -m lidarslam map /path/to/rosbag2 --odometry-params my_rko_lio.yaml \
--backend-params lidarslam/param/lidarslam.yaml --out map/ # both, in one pass
python -m lidarslam backend /path/to/backend_input \
--params lidarslam/param/lidarslam_mid360_rko_graph_walking.yaml --out map/ \
-p "extrinsic_lidar2base_quat_xyzw_xyz:=[0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0]"
--params takes the same parameter file as the ROS 2 RKO-LIO node (ros__parameters layout), with imu_topic, lidar_topic, base_frame and both extrinsic_*2base_quat_xyzw_xyz set. On HILTI exp14 the trajectory is byte-identical to the ROS 2 offline node. Visual and radar fusion still need ROS 2. A lidar_topic of Velodyne packets (velodyne_msgs/msg/VelodyneScan) is decoded as velodyne_transform_node does; set velodyne.model (VLP16 by default, 32C, 32E, VLS128) or velodyne.calibration. The decoder’s per-point time counts from the scan stamp, so lidar_timestamps.force_relative is set for packet input unless the parameter file sets lidar_timestamps.force_relative or force_absolute.
File truncated at 100 lines see the full file
CONTRIBUTING
Contributing
Thanks for contributing to lidarslam_ros2.
This repository is trying to be a practical default for ROS 2 LiDAR SLAM and Autoware pointcloud-map generation. Contributions are most useful when they are easy to reproduce, easy to compare, and clearly scoped.
Participation is governed by the Code of Conduct. The Governance, Support, and Security policies explain decisions, help routes, and private vulnerability reporting.
What To Send
Useful contributions include:
- bug fixes in the default permissive workflow
- Autoware pointcloud-map integration fixes
- benchmark results with reproducible commands and artifacts
- parameter improvements backed by logs and trajectory metrics
- documentation improvements that reduce setup time
Default Workflow Policy
The default and recommended workflow in this repository is permissive-license only. Contributions that change the default path should preserve that property.
Current default path:
RKO-LIO + graph_based_slam- local Scan Context implementation
- Autoware-compatible pointcloud map output
Research frontends with other licenses can still be discussed, but they should not silently become the default path.
Repository Layout
Keep the repository root limited to project metadata and primary entry-point
documents. Place commands under scripts/, offline libraries under tools/,
and small research outputs under docs/research/artifacts/. Do not commit
colcon manifests or other generated build products. See the
repository layout guide for the complete map.
Autoware Naming And Trademark Guidance
Keep Autoware references descriptive.
Preferred wording:
Autoware-compatible pointcloud mappointcloud-map workflow for Autowareworks with Autowarebuilt on Autoware
Avoid branding this repository or a derived product as if it were an official Autoware product or a Foundation-approved distribution.
Avoid wording such as:
-
Autoware-readyas a product tag line official AutowareAutoware <product-name>certified by Autowareendorsed by the Autoware Foundation
If in doubt, prefer compatibility language over product-name language.
Before Opening An Issue
Please collect the smallest reproducible case you can. Use the structured bug, feature, sensor-support, benchmark, or Autoware issue form that best matches the request. Usage questions must include the diagnostic bundle listed in SUPPORT.md.
If you completed a first map from the public docs without live maintainer guidance, use the independent first-map validation form. Passing reports may count toward the v1.0 three-user gate; failed attempts are recorded as onboarding findings and are just as valuable.
For bug reports, keep ordinary doctor <bag> --json output local because it
contains the bag path and local commands. Instead run and review:
lidarslam-map doctor <rosbag2_dir> --public-json
Paste that complete public-doctor-evidence-v1 path-free JSON, a redacted
command shape, expected/observed behavior, and either one reviewed support ZIP
from an existing session or an explicit no-session/no-ZIP statement with the
first finding code. Never attach a bag, map, trajectory, raw log/data,
parameter file, terminal history, or private-site image.
For Autoware-related reports, include:
- projector type and whether an origin exists, with every coordinate and
MGRS/grid identifier and precise origin value replaced by
REDACTED - the non-geometry verifier findings, with private paths and precise locations
File truncated at 100 lines see the full file
Repository Summary
| Description | |
| Checkout URI | https://github.com/rsasaki0109/lidarslam_ros2.git |
| VCS Type | git |
| VCS Version | develop |
| Last Updated | 2026-11-18 |
| Dev Status | UNKNOWN |
| Released | UNRELEASED |
| Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
| Name | Version |
|---|---|
| lidarslam_registration_plugin_template | 0.1.0 |
| graph_based_slam | 0.13.0 |
| lidarslam | 0.13.0 |
| lidarslam_default_plugins | 0.6.0 |
| lidarslam_fake_registration_plugins | 0.6.0 |
| lidarslam_msgs | 0.13.0 |
| lidarslam_plugin_interfaces | 0.6.0 |
| lidarslam_registration_loader | 0.6.0 |
| scanmatcher | 0.13.0 |
README
lidar_slam
Turn a rosbag into a map you can actually drive on. LiDAR SLAM that writes an Autoware-compatible map bundle: pointcloud_map/, map_projector_info.yaml and lanelet2. It runs as ROS 2 packages (Humble, Jazzy) or without ROS 2 from pip install lidarslam. RKO-LIO (MIT) + graph_based_slam (BSD-2), no GPL on the default workflow. Try it in your browser · Open in Colab · 日本語クイックスタート · release notes v0.13.0 · v0.12.0
Documentation · Supported inputs and outputs · Workflow and benchmark comparison
Outdoor walk, APE 0.55 m (Koide, CC BY 4.0) · camera-coloured park (RTK-SLAM, CC BY 4.0) · stairs, ATE 0.24 m on development data · held-out metro tunnel, 0.38 m like BIEVR-LIO and FAST-LIO2 (GEODE) · three separate walks joined into one map with no position hint (Oxford Spires, CC BY-NC-SA 4.0). How these were made.
Quickstart
Choose your shortest path
| Goal | Start here | Safety and cost boundary |
|---|---|---|
| See a verified map, no build | Default if unsure: Docker demo | Stable v0.12.0-humble; needs Docker; host writes stay in ./lidarslam_output. |
| Map my own rosbag |
Own-bag route: lidarslam-map doctor /path/to/rosbag2
|
Read-only diagnosis first; then lidarslam-map start /path/to/rosbag2 writes a new output. |
| Build from source or contribute |
Source quickstart: bash scripts/source_quickstart.sh --dry-run
|
Release v0.12.0; needs ROS 2, 8 GiB, and roughly 30 minutes. |
| Map a bag without ROS 2 (preview) |
pip install: pip install lidarslam-*.whl (prebuilt) or pip install ./lidarslam_core, then lidarslam-map start /path/to/rosbag2
|
No ROS 2; the prebuilt wheel needs no apt packages (Linux x86_64/aarch64, Python 3.10-3.13). RKO-LIO profiles; with --lidarslam-param lidarslam_rtk_gnss.yaml the map is anchored to the bag’s RTK GNSS (/gnss/fix); Velodyne packet bags (VelodyneScan + Imu) with --engine core. The classic GNSS and packet profiles need ROS 2. |
Try it with Docker (one command, no build)
docker run --rm -e LIDARSLAM_HOST_UID="$(id -u)" -e LIDARSLAM_HOST_GID="$(id -g)" \
-v "$PWD/lidarslam_output:/lidarslam_ws/output" \
ghcr.io/rsasaki0109/lidar_slam_ros2:v0.12.0-humble
The repository was renamed from lidar_slam_ros2 to lidar_slam; the v0.12.0 images keep their published name ghcr.io/rsasaki0109/lidar_slam_ros2, and old GitHub links redirect.
The 517 MB MID-360 demo writes lidarslam_output/mid360_demo/ as your user. Other platforms: Getting Started.
Map your own bag (one command after install)
lidarslam-map start /path/to/rosbag2
Run lidarslam-map with no arguments for a guided start, or lidarslam-map doctor first: it uses no network and writes no files. See supported inputs.
Build + verified demo from source (one helper)
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
bash scripts/source_quickstart.sh
The helper detects Humble/Jazzy, installs the dependencies, builds the six maintained packages and runs the verified demo (--dry-run, --build-only). It prints a lidarslam-map path that auto-activates this build. Needs ROS 2, 8 GiB and about 30 minutes. Before handoff: python3 scripts/check_first_map_verification_package.py --json, continue only on READY.
Without ROS 2 (pip, preview)
ROS 2 is becoming one option rather than a requirement. The pip package installs the lidarslam-map command with the RKO-LIO odometry and the graph_based_slam backend (loop closure, pose graph, refinement, Autoware map bundle) inside, and reads rosbag2 (MCAP, SQLite3) and ROS 1 bags without ROS 2 (roadmap).
Prebuilt wheel (no apt packages, no compiler). The wheels workflow builds manylinux wheels (glibc 2.28+, x86_64 and aarch64, Python 3.10-3.13) that bundle PCL, g2o and the other C++ libraries. From the first release published to PyPI on, pip install lidarslam installs them. Until then, open the latest successful run on develop, download lidarslam-wheels-x86_64 (or -aarch64; GitHub sign-in needed), unzip it and install the wheel for your Python:
python3 -m venv .venv && . .venv/bin/activate
pip install lidarslam-*-cp312-cp312-manylinux_2_28_x86_64.whl # your cpXY and arch
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
On HILTI exp14 the x86_64 wheel writes the same map bytes as the source install below.
From source (Ubuntu packages, builds the C++ core):
sudo apt install build-essential cmake libeigen3-dev libtbb-dev robin-map-dev \
libpcl-dev libg2o-dev libzstd-dev python3-venv # tested on Ubuntu 24.04
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
python3 -m venv .venv && . .venv/bin/activate
pip install ./lidarslam_core # Python >= 3.10; downloads Sophus while building
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
python -m lidarslam inspect /path/to/rosbag2 # topics and message types
python -m lidarslam odometry /path/to/rosbag2 --params my_rko_lio.yaml --out odom/
python -m lidarslam map /path/to/rosbag2 --odometry-params my_rko_lio.yaml \
--backend-params lidarslam/param/lidarslam.yaml --out map/ # both, in one pass
python -m lidarslam backend /path/to/backend_input \
--params lidarslam/param/lidarslam_mid360_rko_graph_walking.yaml --out map/ \
-p "extrinsic_lidar2base_quat_xyzw_xyz:=[0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0]"
--params takes the same parameter file as the ROS 2 RKO-LIO node (ros__parameters layout), with imu_topic, lidar_topic, base_frame and both extrinsic_*2base_quat_xyzw_xyz set. On HILTI exp14 the trajectory is byte-identical to the ROS 2 offline node. Visual and radar fusion still need ROS 2. A lidar_topic of Velodyne packets (velodyne_msgs/msg/VelodyneScan) is decoded as velodyne_transform_node does; set velodyne.model (VLP16 by default, 32C, 32E, VLS128) or velodyne.calibration. The decoder’s per-point time counts from the scan stamp, so lidar_timestamps.force_relative is set for packet input unless the parameter file sets lidar_timestamps.force_relative or force_absolute.
File truncated at 100 lines see the full file
CONTRIBUTING
Contributing
Thanks for contributing to lidarslam_ros2.
This repository is trying to be a practical default for ROS 2 LiDAR SLAM and Autoware pointcloud-map generation. Contributions are most useful when they are easy to reproduce, easy to compare, and clearly scoped.
Participation is governed by the Code of Conduct. The Governance, Support, and Security policies explain decisions, help routes, and private vulnerability reporting.
What To Send
Useful contributions include:
- bug fixes in the default permissive workflow
- Autoware pointcloud-map integration fixes
- benchmark results with reproducible commands and artifacts
- parameter improvements backed by logs and trajectory metrics
- documentation improvements that reduce setup time
Default Workflow Policy
The default and recommended workflow in this repository is permissive-license only. Contributions that change the default path should preserve that property.
Current default path:
RKO-LIO + graph_based_slam- local Scan Context implementation
- Autoware-compatible pointcloud map output
Research frontends with other licenses can still be discussed, but they should not silently become the default path.
Repository Layout
Keep the repository root limited to project metadata and primary entry-point
documents. Place commands under scripts/, offline libraries under tools/,
and small research outputs under docs/research/artifacts/. Do not commit
colcon manifests or other generated build products. See the
repository layout guide for the complete map.
Autoware Naming And Trademark Guidance
Keep Autoware references descriptive.
Preferred wording:
Autoware-compatible pointcloud mappointcloud-map workflow for Autowareworks with Autowarebuilt on Autoware
Avoid branding this repository or a derived product as if it were an official Autoware product or a Foundation-approved distribution.
Avoid wording such as:
-
Autoware-readyas a product tag line official AutowareAutoware <product-name>certified by Autowareendorsed by the Autoware Foundation
If in doubt, prefer compatibility language over product-name language.
Before Opening An Issue
Please collect the smallest reproducible case you can. Use the structured bug, feature, sensor-support, benchmark, or Autoware issue form that best matches the request. Usage questions must include the diagnostic bundle listed in SUPPORT.md.
If you completed a first map from the public docs without live maintainer guidance, use the independent first-map validation form. Passing reports may count toward the v1.0 three-user gate; failed attempts are recorded as onboarding findings and are just as valuable.
For bug reports, keep ordinary doctor <bag> --json output local because it
contains the bag path and local commands. Instead run and review:
lidarslam-map doctor <rosbag2_dir> --public-json
Paste that complete public-doctor-evidence-v1 path-free JSON, a redacted
command shape, expected/observed behavior, and either one reviewed support ZIP
from an existing session or an explicit no-session/no-ZIP statement with the
first finding code. Never attach a bag, map, trajectory, raw log/data,
parameter file, terminal history, or private-site image.
For Autoware-related reports, include:
- projector type and whether an origin exists, with every coordinate and
MGRS/grid identifier and precise origin value replaced by
REDACTED - the non-geometry verifier findings, with private paths and precise locations
File truncated at 100 lines see the full file
Repository Summary
| Description | |
| Checkout URI | https://github.com/rsasaki0109/lidarslam_ros2.git |
| VCS Type | git |
| VCS Version | develop |
| Last Updated | 2026-11-18 |
| Dev Status | UNKNOWN |
| Released | UNRELEASED |
| Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
| Name | Version |
|---|---|
| lidarslam_registration_plugin_template | 0.1.0 |
| graph_based_slam | 0.13.0 |
| lidarslam | 0.13.0 |
| lidarslam_default_plugins | 0.6.0 |
| lidarslam_fake_registration_plugins | 0.6.0 |
| lidarslam_msgs | 0.13.0 |
| lidarslam_plugin_interfaces | 0.6.0 |
| lidarslam_registration_loader | 0.6.0 |
| scanmatcher | 0.13.0 |
README
lidar_slam
Turn a rosbag into a map you can actually drive on. LiDAR SLAM that writes an Autoware-compatible map bundle: pointcloud_map/, map_projector_info.yaml and lanelet2. It runs as ROS 2 packages (Humble, Jazzy) or without ROS 2 from pip install lidarslam. RKO-LIO (MIT) + graph_based_slam (BSD-2), no GPL on the default workflow. Try it in your browser · Open in Colab · 日本語クイックスタート · release notes v0.13.0 · v0.12.0
Documentation · Supported inputs and outputs · Workflow and benchmark comparison
Outdoor walk, APE 0.55 m (Koide, CC BY 4.0) · camera-coloured park (RTK-SLAM, CC BY 4.0) · stairs, ATE 0.24 m on development data · held-out metro tunnel, 0.38 m like BIEVR-LIO and FAST-LIO2 (GEODE) · three separate walks joined into one map with no position hint (Oxford Spires, CC BY-NC-SA 4.0). How these were made.
Quickstart
Choose your shortest path
| Goal | Start here | Safety and cost boundary |
|---|---|---|
| See a verified map, no build | Default if unsure: Docker demo | Stable v0.12.0-humble; needs Docker; host writes stay in ./lidarslam_output. |
| Map my own rosbag |
Own-bag route: lidarslam-map doctor /path/to/rosbag2
|
Read-only diagnosis first; then lidarslam-map start /path/to/rosbag2 writes a new output. |
| Build from source or contribute |
Source quickstart: bash scripts/source_quickstart.sh --dry-run
|
Release v0.12.0; needs ROS 2, 8 GiB, and roughly 30 minutes. |
| Map a bag without ROS 2 (preview) |
pip install: pip install lidarslam-*.whl (prebuilt) or pip install ./lidarslam_core, then lidarslam-map start /path/to/rosbag2
|
No ROS 2; the prebuilt wheel needs no apt packages (Linux x86_64/aarch64, Python 3.10-3.13). RKO-LIO profiles; with --lidarslam-param lidarslam_rtk_gnss.yaml the map is anchored to the bag’s RTK GNSS (/gnss/fix); Velodyne packet bags (VelodyneScan + Imu) with --engine core. The classic GNSS and packet profiles need ROS 2. |
Try it with Docker (one command, no build)
docker run --rm -e LIDARSLAM_HOST_UID="$(id -u)" -e LIDARSLAM_HOST_GID="$(id -g)" \
-v "$PWD/lidarslam_output:/lidarslam_ws/output" \
ghcr.io/rsasaki0109/lidar_slam_ros2:v0.12.0-humble
The repository was renamed from lidar_slam_ros2 to lidar_slam; the v0.12.0 images keep their published name ghcr.io/rsasaki0109/lidar_slam_ros2, and old GitHub links redirect.
The 517 MB MID-360 demo writes lidarslam_output/mid360_demo/ as your user. Other platforms: Getting Started.
Map your own bag (one command after install)
lidarslam-map start /path/to/rosbag2
Run lidarslam-map with no arguments for a guided start, or lidarslam-map doctor first: it uses no network and writes no files. See supported inputs.
Build + verified demo from source (one helper)
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
bash scripts/source_quickstart.sh
The helper detects Humble/Jazzy, installs the dependencies, builds the six maintained packages and runs the verified demo (--dry-run, --build-only). It prints a lidarslam-map path that auto-activates this build. Needs ROS 2, 8 GiB and about 30 minutes. Before handoff: python3 scripts/check_first_map_verification_package.py --json, continue only on READY.
Without ROS 2 (pip, preview)
ROS 2 is becoming one option rather than a requirement. The pip package installs the lidarslam-map command with the RKO-LIO odometry and the graph_based_slam backend (loop closure, pose graph, refinement, Autoware map bundle) inside, and reads rosbag2 (MCAP, SQLite3) and ROS 1 bags without ROS 2 (roadmap).
Prebuilt wheel (no apt packages, no compiler). The wheels workflow builds manylinux wheels (glibc 2.28+, x86_64 and aarch64, Python 3.10-3.13) that bundle PCL, g2o and the other C++ libraries. From the first release published to PyPI on, pip install lidarslam installs them. Until then, open the latest successful run on develop, download lidarslam-wheels-x86_64 (or -aarch64; GitHub sign-in needed), unzip it and install the wheel for your Python:
python3 -m venv .venv && . .venv/bin/activate
pip install lidarslam-*-cp312-cp312-manylinux_2_28_x86_64.whl # your cpXY and arch
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
On HILTI exp14 the x86_64 wheel writes the same map bytes as the source install below.
From source (Ubuntu packages, builds the C++ core):
sudo apt install build-essential cmake libeigen3-dev libtbb-dev robin-map-dev \
libpcl-dev libg2o-dev libzstd-dev python3-venv # tested on Ubuntu 24.04
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
python3 -m venv .venv && . .venv/bin/activate
pip install ./lidarslam_core # Python >= 3.10; downloads Sophus while building
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
python -m lidarslam inspect /path/to/rosbag2 # topics and message types
python -m lidarslam odometry /path/to/rosbag2 --params my_rko_lio.yaml --out odom/
python -m lidarslam map /path/to/rosbag2 --odometry-params my_rko_lio.yaml \
--backend-params lidarslam/param/lidarslam.yaml --out map/ # both, in one pass
python -m lidarslam backend /path/to/backend_input \
--params lidarslam/param/lidarslam_mid360_rko_graph_walking.yaml --out map/ \
-p "extrinsic_lidar2base_quat_xyzw_xyz:=[0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0]"
--params takes the same parameter file as the ROS 2 RKO-LIO node (ros__parameters layout), with imu_topic, lidar_topic, base_frame and both extrinsic_*2base_quat_xyzw_xyz set. On HILTI exp14 the trajectory is byte-identical to the ROS 2 offline node. Visual and radar fusion still need ROS 2. A lidar_topic of Velodyne packets (velodyne_msgs/msg/VelodyneScan) is decoded as velodyne_transform_node does; set velodyne.model (VLP16 by default, 32C, 32E, VLS128) or velodyne.calibration. The decoder’s per-point time counts from the scan stamp, so lidar_timestamps.force_relative is set for packet input unless the parameter file sets lidar_timestamps.force_relative or force_absolute.
File truncated at 100 lines see the full file
CONTRIBUTING
Contributing
Thanks for contributing to lidarslam_ros2.
This repository is trying to be a practical default for ROS 2 LiDAR SLAM and Autoware pointcloud-map generation. Contributions are most useful when they are easy to reproduce, easy to compare, and clearly scoped.
Participation is governed by the Code of Conduct. The Governance, Support, and Security policies explain decisions, help routes, and private vulnerability reporting.
What To Send
Useful contributions include:
- bug fixes in the default permissive workflow
- Autoware pointcloud-map integration fixes
- benchmark results with reproducible commands and artifacts
- parameter improvements backed by logs and trajectory metrics
- documentation improvements that reduce setup time
Default Workflow Policy
The default and recommended workflow in this repository is permissive-license only. Contributions that change the default path should preserve that property.
Current default path:
RKO-LIO + graph_based_slam- local Scan Context implementation
- Autoware-compatible pointcloud map output
Research frontends with other licenses can still be discussed, but they should not silently become the default path.
Repository Layout
Keep the repository root limited to project metadata and primary entry-point
documents. Place commands under scripts/, offline libraries under tools/,
and small research outputs under docs/research/artifacts/. Do not commit
colcon manifests or other generated build products. See the
repository layout guide for the complete map.
Autoware Naming And Trademark Guidance
Keep Autoware references descriptive.
Preferred wording:
Autoware-compatible pointcloud mappointcloud-map workflow for Autowareworks with Autowarebuilt on Autoware
Avoid branding this repository or a derived product as if it were an official Autoware product or a Foundation-approved distribution.
Avoid wording such as:
-
Autoware-readyas a product tag line official AutowareAutoware <product-name>certified by Autowareendorsed by the Autoware Foundation
If in doubt, prefer compatibility language over product-name language.
Before Opening An Issue
Please collect the smallest reproducible case you can. Use the structured bug, feature, sensor-support, benchmark, or Autoware issue form that best matches the request. Usage questions must include the diagnostic bundle listed in SUPPORT.md.
If you completed a first map from the public docs without live maintainer guidance, use the independent first-map validation form. Passing reports may count toward the v1.0 three-user gate; failed attempts are recorded as onboarding findings and are just as valuable.
For bug reports, keep ordinary doctor <bag> --json output local because it
contains the bag path and local commands. Instead run and review:
lidarslam-map doctor <rosbag2_dir> --public-json
Paste that complete public-doctor-evidence-v1 path-free JSON, a redacted
command shape, expected/observed behavior, and either one reviewed support ZIP
from an existing session or an explicit no-session/no-ZIP statement with the
first finding code. Never attach a bag, map, trajectory, raw log/data,
parameter file, terminal history, or private-site image.
For Autoware-related reports, include:
- projector type and whether an origin exists, with every coordinate and
MGRS/grid identifier and precise origin value replaced by
REDACTED - the non-geometry verifier findings, with private paths and precise locations
File truncated at 100 lines see the full file
Repository Summary
| Description | |
| Checkout URI | https://github.com/rsasaki0109/lidarslam_ros2.git |
| VCS Type | git |
| VCS Version | develop |
| Last Updated | 2026-11-18 |
| Dev Status | UNKNOWN |
| Released | UNRELEASED |
| Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
| Name | Version |
|---|---|
| lidarslam_registration_plugin_template | 0.1.0 |
| graph_based_slam | 0.13.0 |
| lidarslam | 0.13.0 |
| lidarslam_default_plugins | 0.6.0 |
| lidarslam_fake_registration_plugins | 0.6.0 |
| lidarslam_msgs | 0.13.0 |
| lidarslam_plugin_interfaces | 0.6.0 |
| lidarslam_registration_loader | 0.6.0 |
| scanmatcher | 0.13.0 |
README
lidar_slam
Turn a rosbag into a map you can actually drive on. LiDAR SLAM that writes an Autoware-compatible map bundle: pointcloud_map/, map_projector_info.yaml and lanelet2. It runs as ROS 2 packages (Humble, Jazzy) or without ROS 2 from pip install lidarslam. RKO-LIO (MIT) + graph_based_slam (BSD-2), no GPL on the default workflow. Try it in your browser · Open in Colab · 日本語クイックスタート · release notes v0.13.0 · v0.12.0
Documentation · Supported inputs and outputs · Workflow and benchmark comparison
Outdoor walk, APE 0.55 m (Koide, CC BY 4.0) · camera-coloured park (RTK-SLAM, CC BY 4.0) · stairs, ATE 0.24 m on development data · held-out metro tunnel, 0.38 m like BIEVR-LIO and FAST-LIO2 (GEODE) · three separate walks joined into one map with no position hint (Oxford Spires, CC BY-NC-SA 4.0). How these were made.
Quickstart
Choose your shortest path
| Goal | Start here | Safety and cost boundary |
|---|---|---|
| See a verified map, no build | Default if unsure: Docker demo | Stable v0.12.0-humble; needs Docker; host writes stay in ./lidarslam_output. |
| Map my own rosbag |
Own-bag route: lidarslam-map doctor /path/to/rosbag2
|
Read-only diagnosis first; then lidarslam-map start /path/to/rosbag2 writes a new output. |
| Build from source or contribute |
Source quickstart: bash scripts/source_quickstart.sh --dry-run
|
Release v0.12.0; needs ROS 2, 8 GiB, and roughly 30 minutes. |
| Map a bag without ROS 2 (preview) |
pip install: pip install lidarslam-*.whl (prebuilt) or pip install ./lidarslam_core, then lidarslam-map start /path/to/rosbag2
|
No ROS 2; the prebuilt wheel needs no apt packages (Linux x86_64/aarch64, Python 3.10-3.13). RKO-LIO profiles; with --lidarslam-param lidarslam_rtk_gnss.yaml the map is anchored to the bag’s RTK GNSS (/gnss/fix); Velodyne packet bags (VelodyneScan + Imu) with --engine core. The classic GNSS and packet profiles need ROS 2. |
Try it with Docker (one command, no build)
docker run --rm -e LIDARSLAM_HOST_UID="$(id -u)" -e LIDARSLAM_HOST_GID="$(id -g)" \
-v "$PWD/lidarslam_output:/lidarslam_ws/output" \
ghcr.io/rsasaki0109/lidar_slam_ros2:v0.12.0-humble
The repository was renamed from lidar_slam_ros2 to lidar_slam; the v0.12.0 images keep their published name ghcr.io/rsasaki0109/lidar_slam_ros2, and old GitHub links redirect.
The 517 MB MID-360 demo writes lidarslam_output/mid360_demo/ as your user. Other platforms: Getting Started.
Map your own bag (one command after install)
lidarslam-map start /path/to/rosbag2
Run lidarslam-map with no arguments for a guided start, or lidarslam-map doctor first: it uses no network and writes no files. See supported inputs.
Build + verified demo from source (one helper)
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
bash scripts/source_quickstart.sh
The helper detects Humble/Jazzy, installs the dependencies, builds the six maintained packages and runs the verified demo (--dry-run, --build-only). It prints a lidarslam-map path that auto-activates this build. Needs ROS 2, 8 GiB and about 30 minutes. Before handoff: python3 scripts/check_first_map_verification_package.py --json, continue only on READY.
Without ROS 2 (pip, preview)
ROS 2 is becoming one option rather than a requirement. The pip package installs the lidarslam-map command with the RKO-LIO odometry and the graph_based_slam backend (loop closure, pose graph, refinement, Autoware map bundle) inside, and reads rosbag2 (MCAP, SQLite3) and ROS 1 bags without ROS 2 (roadmap).
Prebuilt wheel (no apt packages, no compiler). The wheels workflow builds manylinux wheels (glibc 2.28+, x86_64 and aarch64, Python 3.10-3.13) that bundle PCL, g2o and the other C++ libraries. From the first release published to PyPI on, pip install lidarslam installs them. Until then, open the latest successful run on develop, download lidarslam-wheels-x86_64 (or -aarch64; GitHub sign-in needed), unzip it and install the wheel for your Python:
python3 -m venv .venv && . .venv/bin/activate
pip install lidarslam-*-cp312-cp312-manylinux_2_28_x86_64.whl # your cpXY and arch
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
On HILTI exp14 the x86_64 wheel writes the same map bytes as the source install below.
From source (Ubuntu packages, builds the C++ core):
sudo apt install build-essential cmake libeigen3-dev libtbb-dev robin-map-dev \
libpcl-dev libg2o-dev libzstd-dev python3-venv # tested on Ubuntu 24.04
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
python3 -m venv .venv && . .venv/bin/activate
pip install ./lidarslam_core # Python >= 3.10; downloads Sophus while building
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
python -m lidarslam inspect /path/to/rosbag2 # topics and message types
python -m lidarslam odometry /path/to/rosbag2 --params my_rko_lio.yaml --out odom/
python -m lidarslam map /path/to/rosbag2 --odometry-params my_rko_lio.yaml \
--backend-params lidarslam/param/lidarslam.yaml --out map/ # both, in one pass
python -m lidarslam backend /path/to/backend_input \
--params lidarslam/param/lidarslam_mid360_rko_graph_walking.yaml --out map/ \
-p "extrinsic_lidar2base_quat_xyzw_xyz:=[0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0]"
--params takes the same parameter file as the ROS 2 RKO-LIO node (ros__parameters layout), with imu_topic, lidar_topic, base_frame and both extrinsic_*2base_quat_xyzw_xyz set. On HILTI exp14 the trajectory is byte-identical to the ROS 2 offline node. Visual and radar fusion still need ROS 2. A lidar_topic of Velodyne packets (velodyne_msgs/msg/VelodyneScan) is decoded as velodyne_transform_node does; set velodyne.model (VLP16 by default, 32C, 32E, VLS128) or velodyne.calibration. The decoder’s per-point time counts from the scan stamp, so lidar_timestamps.force_relative is set for packet input unless the parameter file sets lidar_timestamps.force_relative or force_absolute.
File truncated at 100 lines see the full file
CONTRIBUTING
Contributing
Thanks for contributing to lidarslam_ros2.
This repository is trying to be a practical default for ROS 2 LiDAR SLAM and Autoware pointcloud-map generation. Contributions are most useful when they are easy to reproduce, easy to compare, and clearly scoped.
Participation is governed by the Code of Conduct. The Governance, Support, and Security policies explain decisions, help routes, and private vulnerability reporting.
What To Send
Useful contributions include:
- bug fixes in the default permissive workflow
- Autoware pointcloud-map integration fixes
- benchmark results with reproducible commands and artifacts
- parameter improvements backed by logs and trajectory metrics
- documentation improvements that reduce setup time
Default Workflow Policy
The default and recommended workflow in this repository is permissive-license only. Contributions that change the default path should preserve that property.
Current default path:
RKO-LIO + graph_based_slam- local Scan Context implementation
- Autoware-compatible pointcloud map output
Research frontends with other licenses can still be discussed, but they should not silently become the default path.
Repository Layout
Keep the repository root limited to project metadata and primary entry-point
documents. Place commands under scripts/, offline libraries under tools/,
and small research outputs under docs/research/artifacts/. Do not commit
colcon manifests or other generated build products. See the
repository layout guide for the complete map.
Autoware Naming And Trademark Guidance
Keep Autoware references descriptive.
Preferred wording:
Autoware-compatible pointcloud mappointcloud-map workflow for Autowareworks with Autowarebuilt on Autoware
Avoid branding this repository or a derived product as if it were an official Autoware product or a Foundation-approved distribution.
Avoid wording such as:
-
Autoware-readyas a product tag line official AutowareAutoware <product-name>certified by Autowareendorsed by the Autoware Foundation
If in doubt, prefer compatibility language over product-name language.
Before Opening An Issue
Please collect the smallest reproducible case you can. Use the structured bug, feature, sensor-support, benchmark, or Autoware issue form that best matches the request. Usage questions must include the diagnostic bundle listed in SUPPORT.md.
If you completed a first map from the public docs without live maintainer guidance, use the independent first-map validation form. Passing reports may count toward the v1.0 three-user gate; failed attempts are recorded as onboarding findings and are just as valuable.
For bug reports, keep ordinary doctor <bag> --json output local because it
contains the bag path and local commands. Instead run and review:
lidarslam-map doctor <rosbag2_dir> --public-json
Paste that complete public-doctor-evidence-v1 path-free JSON, a redacted
command shape, expected/observed behavior, and either one reviewed support ZIP
from an existing session or an explicit no-session/no-ZIP statement with the
first finding code. Never attach a bag, map, trajectory, raw log/data,
parameter file, terminal history, or private-site image.
For Autoware-related reports, include:
- projector type and whether an origin exists, with every coordinate and
MGRS/grid identifier and precise origin value replaced by
REDACTED - the non-geometry verifier findings, with private paths and precise locations
File truncated at 100 lines see the full file
Repository Summary
| Description | |
| Checkout URI | https://github.com/rsasaki0109/lidarslam_ros2.git |
| VCS Type | git |
| VCS Version | develop |
| Last Updated | 2026-11-18 |
| Dev Status | UNKNOWN |
| Released | UNRELEASED |
| Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
| Name | Version |
|---|---|
| lidarslam_registration_plugin_template | 0.1.0 |
| graph_based_slam | 0.13.0 |
| lidarslam | 0.13.0 |
| lidarslam_default_plugins | 0.6.0 |
| lidarslam_fake_registration_plugins | 0.6.0 |
| lidarslam_msgs | 0.13.0 |
| lidarslam_plugin_interfaces | 0.6.0 |
| lidarslam_registration_loader | 0.6.0 |
| scanmatcher | 0.13.0 |
README
lidar_slam
Turn a rosbag into a map you can actually drive on. LiDAR SLAM that writes an Autoware-compatible map bundle: pointcloud_map/, map_projector_info.yaml and lanelet2. It runs as ROS 2 packages (Humble, Jazzy) or without ROS 2 from pip install lidarslam. RKO-LIO (MIT) + graph_based_slam (BSD-2), no GPL on the default workflow. Try it in your browser · Open in Colab · 日本語クイックスタート · release notes v0.13.0 · v0.12.0
Documentation · Supported inputs and outputs · Workflow and benchmark comparison
Outdoor walk, APE 0.55 m (Koide, CC BY 4.0) · camera-coloured park (RTK-SLAM, CC BY 4.0) · stairs, ATE 0.24 m on development data · held-out metro tunnel, 0.38 m like BIEVR-LIO and FAST-LIO2 (GEODE) · three separate walks joined into one map with no position hint (Oxford Spires, CC BY-NC-SA 4.0). How these were made.
Quickstart
Choose your shortest path
| Goal | Start here | Safety and cost boundary |
|---|---|---|
| See a verified map, no build | Default if unsure: Docker demo | Stable v0.12.0-humble; needs Docker; host writes stay in ./lidarslam_output. |
| Map my own rosbag |
Own-bag route: lidarslam-map doctor /path/to/rosbag2
|
Read-only diagnosis first; then lidarslam-map start /path/to/rosbag2 writes a new output. |
| Build from source or contribute |
Source quickstart: bash scripts/source_quickstart.sh --dry-run
|
Release v0.12.0; needs ROS 2, 8 GiB, and roughly 30 minutes. |
| Map a bag without ROS 2 (preview) |
pip install: pip install lidarslam-*.whl (prebuilt) or pip install ./lidarslam_core, then lidarslam-map start /path/to/rosbag2
|
No ROS 2; the prebuilt wheel needs no apt packages (Linux x86_64/aarch64, Python 3.10-3.13). RKO-LIO profiles; with --lidarslam-param lidarslam_rtk_gnss.yaml the map is anchored to the bag’s RTK GNSS (/gnss/fix); Velodyne packet bags (VelodyneScan + Imu) with --engine core. The classic GNSS and packet profiles need ROS 2. |
Try it with Docker (one command, no build)
docker run --rm -e LIDARSLAM_HOST_UID="$(id -u)" -e LIDARSLAM_HOST_GID="$(id -g)" \
-v "$PWD/lidarslam_output:/lidarslam_ws/output" \
ghcr.io/rsasaki0109/lidar_slam_ros2:v0.12.0-humble
The repository was renamed from lidar_slam_ros2 to lidar_slam; the v0.12.0 images keep their published name ghcr.io/rsasaki0109/lidar_slam_ros2, and old GitHub links redirect.
The 517 MB MID-360 demo writes lidarslam_output/mid360_demo/ as your user. Other platforms: Getting Started.
Map your own bag (one command after install)
lidarslam-map start /path/to/rosbag2
Run lidarslam-map with no arguments for a guided start, or lidarslam-map doctor first: it uses no network and writes no files. See supported inputs.
Build + verified demo from source (one helper)
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
bash scripts/source_quickstart.sh
The helper detects Humble/Jazzy, installs the dependencies, builds the six maintained packages and runs the verified demo (--dry-run, --build-only). It prints a lidarslam-map path that auto-activates this build. Needs ROS 2, 8 GiB and about 30 minutes. Before handoff: python3 scripts/check_first_map_verification_package.py --json, continue only on READY.
Without ROS 2 (pip, preview)
ROS 2 is becoming one option rather than a requirement. The pip package installs the lidarslam-map command with the RKO-LIO odometry and the graph_based_slam backend (loop closure, pose graph, refinement, Autoware map bundle) inside, and reads rosbag2 (MCAP, SQLite3) and ROS 1 bags without ROS 2 (roadmap).
Prebuilt wheel (no apt packages, no compiler). The wheels workflow builds manylinux wheels (glibc 2.28+, x86_64 and aarch64, Python 3.10-3.13) that bundle PCL, g2o and the other C++ libraries. From the first release published to PyPI on, pip install lidarslam installs them. Until then, open the latest successful run on develop, download lidarslam-wheels-x86_64 (or -aarch64; GitHub sign-in needed), unzip it and install the wheel for your Python:
python3 -m venv .venv && . .venv/bin/activate
pip install lidarslam-*-cp312-cp312-manylinux_2_28_x86_64.whl # your cpXY and arch
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
On HILTI exp14 the x86_64 wheel writes the same map bytes as the source install below.
From source (Ubuntu packages, builds the C++ core):
sudo apt install build-essential cmake libeigen3-dev libtbb-dev robin-map-dev \
libpcl-dev libg2o-dev libzstd-dev python3-venv # tested on Ubuntu 24.04
git clone --recursive https://github.com/rsasaki0109/lidar_slam.git
cd lidar_slam
python3 -m venv .venv && . .venv/bin/activate
pip install ./lidarslam_core # Python >= 3.10; downloads Sophus while building
lidarslam-map doctor # ready: map engine core, no ROS 2 needed
lidarslam-map start /path/to/rosbag2 # verified Autoware map bundle, lanelet2, 3D preview
python -m lidarslam inspect /path/to/rosbag2 # topics and message types
python -m lidarslam odometry /path/to/rosbag2 --params my_rko_lio.yaml --out odom/
python -m lidarslam map /path/to/rosbag2 --odometry-params my_rko_lio.yaml \
--backend-params lidarslam/param/lidarslam.yaml --out map/ # both, in one pass
python -m lidarslam backend /path/to/backend_input \
--params lidarslam/param/lidarslam_mid360_rko_graph_walking.yaml --out map/ \
-p "extrinsic_lidar2base_quat_xyzw_xyz:=[0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0]"
--params takes the same parameter file as the ROS 2 RKO-LIO node (ros__parameters layout), with imu_topic, lidar_topic, base_frame and both extrinsic_*2base_quat_xyzw_xyz set. On HILTI exp14 the trajectory is byte-identical to the ROS 2 offline node. Visual and radar fusion still need ROS 2. A lidar_topic of Velodyne packets (velodyne_msgs/msg/VelodyneScan) is decoded as velodyne_transform_node does; set velodyne.model (VLP16 by default, 32C, 32E, VLS128) or velodyne.calibration. The decoder’s per-point time counts from the scan stamp, so lidar_timestamps.force_relative is set for packet input unless the parameter file sets lidar_timestamps.force_relative or force_absolute.
File truncated at 100 lines see the full file
CONTRIBUTING
Contributing
Thanks for contributing to lidarslam_ros2.
This repository is trying to be a practical default for ROS 2 LiDAR SLAM and Autoware pointcloud-map generation. Contributions are most useful when they are easy to reproduce, easy to compare, and clearly scoped.
Participation is governed by the Code of Conduct. The Governance, Support, and Security policies explain decisions, help routes, and private vulnerability reporting.
What To Send
Useful contributions include:
- bug fixes in the default permissive workflow
- Autoware pointcloud-map integration fixes
- benchmark results with reproducible commands and artifacts
- parameter improvements backed by logs and trajectory metrics
- documentation improvements that reduce setup time
Default Workflow Policy
The default and recommended workflow in this repository is permissive-license only. Contributions that change the default path should preserve that property.
Current default path:
RKO-LIO + graph_based_slam- local Scan Context implementation
- Autoware-compatible pointcloud map output
Research frontends with other licenses can still be discussed, but they should not silently become the default path.
Repository Layout
Keep the repository root limited to project metadata and primary entry-point
documents. Place commands under scripts/, offline libraries under tools/,
and small research outputs under docs/research/artifacts/. Do not commit
colcon manifests or other generated build products. See the
repository layout guide for the complete map.
Autoware Naming And Trademark Guidance
Keep Autoware references descriptive.
Preferred wording:
Autoware-compatible pointcloud mappointcloud-map workflow for Autowareworks with Autowarebuilt on Autoware
Avoid branding this repository or a derived product as if it were an official Autoware product or a Foundation-approved distribution.
Avoid wording such as:
-
Autoware-readyas a product tag line official AutowareAutoware <product-name>certified by Autowareendorsed by the Autoware Foundation
If in doubt, prefer compatibility language over product-name language.
Before Opening An Issue
Please collect the smallest reproducible case you can. Use the structured bug, feature, sensor-support, benchmark, or Autoware issue form that best matches the request. Usage questions must include the diagnostic bundle listed in SUPPORT.md.
If you completed a first map from the public docs without live maintainer guidance, use the independent first-map validation form. Passing reports may count toward the v1.0 three-user gate; failed attempts are recorded as onboarding findings and are just as valuable.
For bug reports, keep ordinary doctor <bag> --json output local because it
contains the bag path and local commands. Instead run and review:
lidarslam-map doctor <rosbag2_dir> --public-json
Paste that complete public-doctor-evidence-v1 path-free JSON, a redacted
command shape, expected/observed behavior, and either one reviewed support ZIP
from an existing session or an explicit no-session/no-ZIP statement with the
first finding code. Never attach a bag, map, trajectory, raw log/data,
parameter file, terminal history, or private-site image.
For Autoware-related reports, include:
- projector type and whether an origin exists, with every coordinate and
MGRS/grid identifier and precise origin value replaced by
REDACTED - the non-geometry verifier findings, with private paths and precise locations
File truncated at 100 lines see the full file