Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
…ecking into paper
  • Loading branch information
mazrk7 committed Dec 20, 2024
2 parents 0da4d48 + ae61888 commit 59f199f
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,22 @@ sudo make install

If there are errors, such as constants not being found, then you are probably still using the older version of FCL.

### Other Dependencies
### Workspace Setup

Don't forget to also install any system dependencies through `rosdep` after installing the above libraries, e.g., in the root directory of your ROS workspace run:
You can now clone the `robot_collision_checking` repository in your ROS workspace (set to the appropriate `$ROS_DISTRO` branch). Don't forget to install
any other system dependencies through `rosdep` after installing the above libraries, e.g., in the root directory of your ROS workspace run:
```
rosdep install --from-paths src --ignore-src -y
```

## Alternative - Docker Image

If you instead wish to explore the package in a Docker image, there is a `Dockerfile` available. Simply clone the repository or download the `Dockerfile` and
then run:
```
docker build --tag 'robot_collision_checking' . && docker run -it 'robot_collision_checking' bash
```

## Testing

You can run tests for the `robot_collision_checking` package as described in [this ROS 2 tutorial](https://docs.ros.org/en/humble/Tutorials/Intermediate/Testing/CLI.html). First compile the tests:
Expand All @@ -79,7 +88,10 @@ A toy example is provided in the `examples` directory and can be run as follows:
```
ros2 run robot_collision_checking fcl_interface_example
```
Separately run an instance of `rviz2` and set the global fixed frame to "world" to visualize the collision world.
Separately run an instance of `rviz2` and set the global fixed frame to "world" to visualize the collision world. You can install `rviz2` on Debian systems by running:
```
sudo apt install ros-$ROS_DISTRO-rviz2
```

Within this ROS node, a few key pieces of functionality are provided:
- First, the `initCollisionWorld()` method demonstrates how a collision world composed of different geometric shapes and types (meshes, planes, voxel grids, etc.) can be constructed
Expand Down

0 comments on commit 59f199f

Please sign in to comment.