Skip to content

Commit

Permalink
update readme and changelog for Isaac Sim 4.5 support
Browse files Browse the repository at this point in the history
  • Loading branch information
jaybdub committed Feb 6, 2025
1 parent 2728f47 commit 4c98900
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 6 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

# main

# ref-4.5

Release targeting Isaac Sim 4.5

- Updated to use isaacsim.* rather than omni.* import calls
- Added minor fixes to API discrepancies
- Added required extension loading for replay rendering
- Updated README to include setup instructions for Isaac Sim 4.5

# ref-4.2

Release targeting Isaac Sim 4.2
Expand Down
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ To get started with MobilityGen follow the setup and usage instructions below!
- [How to implement a custom scenario](#how-to-custom-scenario)
- [📝 Data Format](#-data-format)
- [👏 Contributing](#-contributing)
-

<a id="setup"></a>
## 🛠️ Setup
Expand All @@ -64,7 +65,9 @@ Follow these steps to set up MobilityGen

### Step 1 - Install Isaac Sim

1. Using the ``Omniverse Launcher`` install ``Isaac Sim 4.2.0``
1. Download [Isaac Sim 4.5.0](https://docs.isaacsim.omniverse.nvidia.com/latest/installation/download.html)

> We'll assume you use the zip file and extract it to ``~/isaacsim``.
### Step 2 - Clone this repository

Expand All @@ -86,25 +89,31 @@ Next, we'll call ``link_app.sh`` to link the Isaac Sim installation directory to
cd MobilityGen
```
2. Run the following to link the ``app`` folder
2. Run the following to link the ``app`` folder and pass it the path to where you installed Isaac Sim
```bash
./link_app.sh
./link_app.sh --path ~/isaacsim
```
<details>
> This step is helpful as it (1) Enables us to use VS code autocompletion (2) Allows us to call ./app/python.sh to launch Isaac Sim Python scripts (3) Allows us to call ./app/isaac-sim.sh to launch Isaac Sim.
</details>
### Step 4 - Install the C++ path planner (for procedural generation)
### Step 4 - Install other python dependencies (including C++ path planner) (for procedural generation)
1. Install miscellaneous python dependencies
```bash
./app/python.sh -m pip install tqdm
```
1. Navigate to the path planner directory
2. Navigate to the path planner directory
```bash
cd MobilityGen/path_planner
```
2. Install with pip using the Isaac Sim python interpreter
3. Install with pip using the Isaac Sim python interpreter
```bash
../app/python.sh -m pip install -e .
Expand Down

0 comments on commit 4c98900

Please sign in to comment.