Skip to content

Commit ac319d4

Browse files
committed
docs: Add omnigraph shortcut tool ref and update wording
1 parent 09678b3 commit ac319d4

2 files changed

Lines changed: 20 additions & 17 deletions

File tree

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
A repo containing essential ROS2 Humble features for controlling Autonomous Mobile Robots (AMRs) and robotic arm manipulators. Please setup an Ubuntu environment before using this repo.
77

8-
The goal of this repo is to allow seamless robot policy reuse between simulation and reality powered by [(Omniverse) Isaac Sim](https://docs.isaacsim.omniverse.nvidia.com/4.5.0/index.html), [Isaac Lab](https://isaac-sim.github.io/IsaacLab/main/index.html), and [Isaac ROS](https://nvidia-isaac-ros.github.io/index.html). In general, the amd64 images support both simulation and real robot control, while the arm64 images only supports real robot control.
8+
The goal of this repo is to allow seamless robot policy reuse between simulation and reality powered by [(Omniverse) Isaac Sim](https://docs.isaacsim.omniverse.nvidia.com/5.1.0/index.html), [Isaac Lab](https://isaac-sim.github.io/IsaacLab/main/index.html), and [Isaac ROS](https://nvidia-isaac-ros.github.io/index.html). In general, the amd64 images support both simulation and real robot control, while the arm64 images only supports real robot control.
99

1010
> Please note that this repo is under rapid development. The code is not guaranteed to be stable, and breaking changes may occur.
1111
@@ -15,12 +15,12 @@ The documentation is hosted on <https://j3soon.github.io/ros2-essentials/>.
1515

1616
| Use Case | Platform | Hardware | Software | Notes |
1717
|----------|----------|----------|----------|-------|
18-
| Simulation/Deployment | x86_64 | RTX GPU, 500GB+ SSD | Ubuntu 22.04, [NVIDIA Driver](https://ubuntu.com/server/docs/nvidia-drivers-installation), [Docker](https://docs.docker.com/engine/install/ubuntu/), [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) | See [this page](https://docs.isaacsim.omniverse.nvidia.com/4.5.0/installation/requirements.html) for more details. |
18+
| Simulation/Deployment | x86_64 | RTX GPU, 500GB+ SSD | Ubuntu 22.04, [NVIDIA Driver](https://ubuntu.com/server/docs/nvidia-drivers-installation), [Docker](https://docs.docker.com/engine/install/ubuntu/), [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) | See [this page](https://docs.isaacsim.omniverse.nvidia.com/5.1.0/installation/requirements.html) for more details. |
1919
| Deployment-Only | Jetson | Jetson Orin, 500GB+ SSD | JetPack 6 | See [this page](https://nvidia-isaac-ros.github.io/getting_started/index.html) for more details.
2020

2121
Make sure to install the required software prerequisites before using this repo.
2222

23-
> Some functionalities may still work on lower-spec systems, such as those without GPUs or on operating systems other than Ubuntu 22.04. However, these configurations are not officially supported and may require manual adjustments. Use them with caution.
23+
> The code may still work on lower-spec systems, such as those without GPUs or on older operating systems. However, these are not tested and may require manual adjustments. Proceed with caution.
2424
2525
## Setup
2626

@@ -30,18 +30,17 @@ cd ros2-essentials
3030
./scripts/post_install.sh
3131
```
3232

33-
> Note that the `post_install.sh` script should be run after each change to the repository (such as switching to another branch or pulling the latest changes).
34-
> In addition, the script can be run with the `-f` or `--force` flag to force removal of hard links if needed.
33+
> Note that the `post_install.sh` script should be run after each change to the repository (such as switching to another branch or pulling the latest changes). In addition, the script can be run with the `-f` or `--force` flag to force removal of hard links if needed.
3534
36-
and then configure the container user ID to match your host user ID by modifying the host `~/.bashrc` (or `~/.zshrc`) to include the following line:
35+
Then, configure the container user ID to match your host user ID by modifying the host `~/.bashrc` (or `~/.zshrc`) to include the following line:
3736

3837
```sh
3938
export USER_UID=$(id -u)
4039
```
4140

4241
This step is optional if you have user ID 1000 on host.
4342

44-
> Next, choose a workspace from the table below and follow its documentation to get started. The rest of this document contains optional information.
43+
Next, choose a workspace from the table below and follow its documentation to get started. The rest of this document contains optional information. The search bar at the top right corner of the [documentation site](https://j3soon.github.io/ros2-essentials/) and [GitHub repository](https://github.com/j3soon/ros2-essentials) is a good way to navigate to the relevant documentation and commits.
4544

4645
## Updating the Repository
4746

@@ -91,6 +90,16 @@ Edit the `build.args` section in the `*_ws/docker/compose.yml` file and rebuild
9190
| [Isaac Lab](https://j3soon.github.io/ros2-essentials/docker-modules/isaac-lab/) | ✔️ || Isaac Lab 2.2.1 Git Install | ✔️ | [Johnson Sun](https://github.com/j3soon) |
9291
| [Isaac ROS](https://j3soon.github.io/ros2-essentials/docker-modules/isaac-ros/) | ✔️ | TODO | Isaac ROS 3.2 Apt Install (Base only) || [Johnson Sun](https://github.com/j3soon) |
9392

93+
## Docker Compose Cleanup
94+
95+
```sh
96+
# cd into a workspace directory's docker directory
97+
docker compose down --volumes --remove-orphans
98+
docker volume rm ros2-gazebo-cache
99+
docker volume rm ros2-isaac-sim-cache
100+
docker volume rm ros2-isaac-ros-assets
101+
```
102+
94103
## Building Documentation
95104

96105
```sh
@@ -152,16 +161,6 @@ The GitHub Actions workflow is designed to share build caches between workspaces
152161

153162
Some current CI builds are flaky and may require re-running.
154163

155-
### Docker Compose Cleanup
156-
157-
```sh
158-
# cd into a workspace directory's docker directory
159-
docker compose down --volumes --remove-orphans
160-
docker volume rm ros2-gazebo-cache
161-
docker volume rm ros2-isaac-sim-cache
162-
docker volume rm ros2-isaac-ros-assets
163-
```
164-
165164
## Acknowledgement
166165

167166
The code is mainly contributed by [Johnson Sun](https://github.com/j3soon), [Yu-Zhong Chen](https://github.com/YuZhong-Chen), [Assume Zhan](https://github.com/Assume-Zhan), and others. For a full list of contributors, please refer to the [contribution list](https://github.com/j3soon/ros2-essentials/graphs/contributors).

docs/docker-modules/isaac-sim.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@ check_urdf $URDF_FILE
6464
6565
> Note: URDF files are often not self-contained and may reference additional resources within their ROS package. For successful import, consider downloading/moving the entire package (such as the `<ROBOT_NAME>_description` directory) along with the URDF file. Otherwise, the import will fail.
6666
67+
## Generating OmniGraph for ROS2
68+
69+
Instead of manually creating the OmniGraph via Isaac Sim GUI or Python code, the easier way is to use the [Graph Shortcut tool](https://docs.isaacsim.omniverse.nvidia.com/5.1.0/ros2_tutorials/tutorial_ros2_manipulation.html#graph-shortcut). A concrete example can be found in [PR#83](https://github.com/j3soon/ros2-essentials/pull/83).
70+
6771
## Known Issues
6872
6973
```sh

0 commit comments

Comments
 (0)