-
- 1. Install [Conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) and NVIDIA's [Omniverse Isaac Sim](https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/install_workstation.html)
-
- !!! warning "Please make sure you have the latest version of Isaac Sim (2023.1.1) installed."
+
- For Ubuntu 22.04, you need to [install FUSE](https://github.com/AppImage/AppImageKit/wiki/FUSE) to run the Omniverse Launcher AppImage.
+ 1. Install [Conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) and NVIDIA's [Omniverse Isaac Sim](https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/install_workstation.html)
- 2. Clone [**`OmniGibson`**](https://github.com/StanfordVL/OmniGibson) and move into the directory:
+ !!! warning "Please make sure you have the currently supported version of Isaac Sim (4.1.0) installed."
- ```shell
- git clone https://github.com/StanfordVL/OmniGibson.git
- cd OmniGibson
- ```
-
- ??? note "Nightly build"
+ For Ubuntu 22.04, you need to [install FUSE](https://github.com/AppImage/AppImageKit/wiki/FUSE) to run the Omniverse Launcher AppImage.
- The main branch contains the stable version of **`OmniGibson`**. For our latest developed (yet not fully tested) features and bug fixes, please clone from the `og-develop` branch.
+ 2. Create a conda environment with Python version **`3.10`**:
- 3. Setup a virtual conda environment to run **`OmniGibson`**:
+ ```shell
+ conda create -n omnigibson python=3.10 pytorch torchvision torchaudio pytorch-cuda=12.1 "numpy<2" -c pytorch -c nvidia
+ conda activate omnigibson
+ ```
- ```{.shell .annotate}
- ./scripts/setup.sh # (1)!
- ```
+ ??? question "What should I do if `conda create` fails?"
- 1. The script will ask you which Isaac Sim to use. If you installed it in the default location, it should be `~/.local/share/ov/pkg/isaac_sim-2023.1.1`
+ Sometimes, conda will fail to resolve dependencies. In that case, you can create a Python-only conda environment
+ first, and then install numpy<2 and PyTorch via pip.
+
+ If the default PyTorch version does not work for you due to a CUDA version compatibility issue, follow instructions
+ on [the PyTorch website](https://pytorch.org/get-started/locally/) to add the correct index option to the pip install
+ line to get a different pytorch version.
- This will create a conda env with `omnigibson` installed. Simply call `conda activate` to activate it.
+ ```shell
+ conda create -n omnigibson python=3.10
+ conda activate omnigibson
+ pip install "numpy<2" torch torchvision torchaudio
+ ```
- 4. Download **`OmniGibson`** dataset (within the conda env):
+ 3. Install OmniGibson:
- ```shell
- python -m omnigibson.download_datasets
- ```
+
-
+ !!! note "Install from PyPI (source not editable)"
-
+ ```shell
+ pip install omnigibson
+ ```
- === "๐ Windows (powershell/cmd)"
+ !!! example "Install from GitHub (source editable)"
-
+ ```shell
+ git clone https://github.com/StanfordVL/OmniGibson.git
+ cd OmniGibson
+ pip install -e .
+ ```
- 1. Install [Conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html) and NVIDIA's [Omniverse Isaac Sim](https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/install_workstation.html)
+
- !!! warning "Please make sure you have the latest version of Isaac Sim (2023.1.1) installed."
+ !!! note "Nightly build"
- 2. Clone [**`OmniGibson`**](https://github.com/StanfordVL/OmniGibson) and move into the directory:
+ The main branch contains the stable version of **`OmniGibson`**. For our latest developed (yet not fully tested) features and bug fixes, please clone from the `og-develop` branch.
- ```shell
- git clone https://github.com/StanfordVL/OmniGibson.git
- cd OmniGibson
- ```
+ 4. Run the installation script to hook the environment up to Isaac Sim as well as **`OmniGibson`** dataset and assets:
- ??? note "Nightly build"
+ ```{.shell .annotate}
+ python -m omnigibson.install --launcher-install # (1)!
+ ```
- The main branch contains the stable version of **`OmniGibson`**. For our latest developed (yet not fully tested) features and bug fixes, please clone from the `og-develop` branch.
+ 1. You can specify your Isaac Sim install location using the argument `--isaac-sim-path` if it differs from the default. You can also apply additional flag `--no-install-datasets` to skip dataset install.
- 3. Setup a virtual conda environment to run **`OmniGibson`**:
+ !!! note "What does this do?"
- ```{.powershell .annotate}
- .\scripts\setup.bat # (1)!
- ```
+ When you install OmniGibson this way, it will modify your conda environment setup to hook it up to the launcher-installed Isaac Sim.
- 1. The script will ask you which Isaac Sim to use. If you installed it in the default location, it should be `C:\Users\
\AppData\Local\ov\pkg\isaac_sim-2023.1.1`
+ 5. Deactivate and reactivate the conda environment:
- This will create a conda env with `omnigibson` installed. Simply call `conda activate` to activate it.
+ Because the environment was modified by the installer to hook it up to the launcher-installed Isaac Sim, you need to reactivate it.
- 4. Download **`OmniGibson`** dataset (within the conda env):
+ ```shell
+ conda deactivate
+ conda activate omnigibson
+ ```
- ```powershell
- python -m omnigibson.download_datasets
- ```
+