Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
digiamm authored Jun 11, 2024
1 parent ffadc26 commit 38e5672
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@
<br />
</div>

# :gift: Install
You can download MAD-ICP using pip
# Install using `pip`
You can download/install MAD-ICP using `pip`
```bash
pip install mad-icp
```

# :rocket: Usage
# Usage

We provide a Python launcher for Rosbag1, Rosbag2, and KITTI binary formats. The dataset configuration file is important for the sensor characteristics and extrinsic information (typically, ground truths are not expressed in the LiDAR frame).

The internal parameters are in `configurations/params.cfg`. All the experiments have been run with this same set.
To run the pipeline, choose the appropriate dataset configuration file (`kitti.cfg`for this example) and type:
The internal parameters are in `configurations/params.cfg` (at the moment if you install this via `pip` you need to clone the repo). All the experiments have been run with this same set.
To run the pipeline, choose the appropriate dataset configuration file (`kitti.cfg` for this example) and type:
```bash
cd mad-icp/
mad_icp --data-path /input_dir/ \
Expand All @@ -36,7 +36,9 @@ Our runner directly saves the odometry estimate file in KITTI format (homogenous

Our pipeline is `anytime realtime`! You can play with parameters `num_keyframes` and `num_cores` and, if you have enough _computation capacity_, we suggest increasing these (we run demo/experiments with `num_keyframes=16` and `num_cores=16`).

# :hammer: Building
____________________________________________________________________

# Building from source

Building is tested by our CI/CD pipeline for Ubuntu 20.04 and Ubuntu 22.04 (using g++).

Expand All @@ -58,7 +60,7 @@ Moreover, you can build the C++ library (along with the pybinds) by typing:
mkdir build && cd build && cmake ../mad_icp && make -j8
```

## :godmode: Building and Running C++ Apps \[Optional\]
## Building and Running C++ Apps \[Optional\]
If you want to avoid Python, we provide the `bin_runner` C++ executable (located in `mad_icp/apps/cpp_runners/bin_runner.cpp`) that accepts binary cloud format (KITTI, Mulran, etc.).
You can build the executable using
```bash
Expand Down

0 comments on commit 38e5672

Please sign in to comment.