space-ros · franklinselva · Aug 31, 2024 · Sep 8, 2024 · Sep 8, 2024 · Sep 8, 2024
diff --git a/.gitattributes b/.gitattributes
@@ -1,3 +1,4 @@
 *.dae filter=lfs diff=lfs merge=lfs -text
 *.stl filter=lfs diff=lfs merge=lfs -text
 *.png filter=lfs diff=lfs merge=lfs -text
+*.usd filter=lfs diff=lfs merge=lfs -text
diff --git a/.gitignore b/.gitignore
diff --git a/CMakeLists.txt b/CMakeLists.txt
diff --git a/README.md b/README.md
@@ -1,5 +1,77 @@
-# simulation
+# Space ROS IsaacSim Extension Package
 
-Simulation assets of space-ros demos
+This repository is an extension module for Nvidia's IsaacSim. It provides the following features:
 
-This repo uses [git-lfs](https://git-lfs.com/) to manage large files.
+ - Simulation Assets for Space Robotics
+ - ROS2 Interface for Space Robotics
+ - Extenstions for IsaacSim for Space Robotics
+
+## System Requirements
+
+The following are the system requirements to run the project:
+
+| Requirement | Description                      |
+| ----------- | -------------------------------- |
+| OS          | Ubuntu 22.04                     |
+| RTX GPU     | Nvidia RTX 30XX Series or higher |
+| RAM         | 16 GB or higher                  |
+| CPU         | Intel i7 or higher               |
+
+
+## Prerequisites
+
+The work is based on Nvidia's IsaacSim. The changes are tested on Ubuntu 22.04. The following dependencies are required to run the project:
+
+| Dependency | Version  | Description                                                                                                                                                                         |
+| ---------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| IsaacSim   | >=4.0.0  | Nvidia's IsaacSim. You can setup the simulation from official website. Instructions [here](https://docs.omniverse.nvidia.com/isaacsim/latest/installation/install_workstation.html) |
+| ROS2       | ==Humble | ROS2 Humble acts as a middle layer. This will be soon ported to the native project. Installation Instructions [here](https://docs.ros.org/en/humble/Installation.html)              |
+
+## Get Started
+
+1. Make sure the prerequisites are installed. If not, follow the instructions in the prerequisites section.
+2. Clone the repository to your local machine in your desired location. Run the following command in the terminal:
+```bash
+git clone https://github.com/space-ros/simulation.git
+
+# This project used git-lfs for large files. Make sure you have git-lfs installed.
+# If not, you can install it by running the following command:
+# sudo apt-get install git-lfs
+
+# Now, you can pull the repository with git-lfs
+cd simulation
+git lfs pull
+```
+3. The repository contains two folders in the root directory:
+    - `extensions`: Contains the extensions for IsaacSim
+    - `assets`: Contains the ROS2 interface for IsaacSim
+4. For easier access to the assetss, you can bookmark the assets folder in the IsaacSim by following the steps:
+    1. Open IsaacSim.
+    2. In the Context Browser, navigate to the root of the repository and right-click on the `assets` folder.
+    3. Click on the `Add Bookmark` option.
+    4. You will be prompted to enter the name of the bookmark. Enter "Space ROS Assets" and click on `OK`.
+    5. Now, you can access the assets from the bookmarks section in the Context Browser.
+5. For the extensions, you need to allow the extension manager of IsaacSim to know the location of the extensions. Follow the steps:
+    1. Open IsaacSim.
+    2. Go to `Windows` in the top menu bar and click on `Extensions`.
+    3. Click on the hamburger icon on the top right corner of the Search bar in the extension manager and select `Settings`.
+    4. On the right panel of the extension manager, find the section for extension search paths and click on the `+` icon at the end of the list.
+    5. Navigate to the `extensions` folder in the repository and select the `extensions` folder.
+    6. The extensions of Space ROS will now be available in the extension manager. You can search for the extensions in the search bar. The list of extensions is provided in the documentation below.
+    7. Click on the extension and enable it by toggling the switch on the right side of the extension. You can also check the `Auto-Enable` option to enable the extension automatically when IsaacSim starts.
+    8. You can repeat the steps for other extensions as well.
+6. Now, you can start using the assets and extensions in the IsaacSim.
+
+> NOTE: Make sure ROS2 Bridge is extension is enabled in the IsaacSim. You can enable it by the previous steps mentioned for the extensions.
+
+## Documentation
+
+This is a brief overview of the documentation provided in the repository. The detailed documentation can be found in the `docs` folder in the repository.
+
+| Section                                                    | Description                                                                                                                                                                                                                                                                                                           |
+| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [Space Robotics Environments](docs/assets/environments.md) | The environment assets provided by Space ROS for Nvidia's IsaacSim:<br>1. International Space Station<br>2. Interior of International Space Station<br>3. Lunar Surface<br>4. Mars Surface<br>5. Simple Chess Environment for Robonaut2<br>6. Simple Mars Replica Environment for Ingenuity Helicopter                |
+| [Space Robotics Robots](docs/assets/robots.md)             | The robot assets provided by Space ROS for Nvidia's IsaacSIM:<br>[1. Curiosity Mars Rover](./docs/robots/curiosity.md)<br>2. Perseverance Mars Rover<br>[3.Ingenuity Helicopter V3](./docs//robots/ingenuity-helicopter.md)<br>[4.Canadarm2](./docs/robots/canadarm2.md)<br>[5.Robonaut2](./docs/robots/robonaut2.md) |
+| [Space Robotics Scenes](docs/assets/scenes.md)             | The environment assets provided by Space ROS for Nvidia's IsaacSim:<br>1. International Space Station with Canadarm2<br>2. Curiosity Mars Rover on Mars Surface<br>3. Simple Chess Environment for Robonaut2<br>4. Simple Mars Replica Environment for Ingenuity Helicopter                                           |
+| [ROS2 Interface](docs/ros2.md)                             | The ROS2 bridge and usage description for integration with Space ROS                                                                                                                                                                                                                                                  |
+| [Extensions for IsaacSim](docs/extensions/index.md)        | The extensions provided by Space ROS for Nvidia's IsaacSim:<br>1. Example Omnigraph Extension for Space ROS<br>2. Omnigraph Extension for Rover Simple Mobile Base Controller                                                                                                                                         |
diff --git a/...nts/InternationalSpaceStation/.thumbs/256x256/InternationalSpaceStation.usd.png b/...nts/InternationalSpaceStation/.thumbs/256x256/InternationalSpaceStation.usd.png
diff --git a/...rnationalSpaceStation/.thumbs/256x256/InternationalSpaceStationInternal.usd.png b/...rnationalSpaceStation/.thumbs/256x256/InternationalSpaceStationInternal.usd.png
diff --git a/assets/Environments/InternationalSpaceStation/InternationalSpaceStation.usd b/assets/Environments/InternationalSpaceStation/InternationalSpaceStation.usd
diff --git a/assets/Environments/InternationalSpaceStation/InternationalSpaceStationInternal.usd b/assets/Environments/InternationalSpaceStation/InternationalSpaceStationInternal.usd
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_01.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_01.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_01_n.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_01_n.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_02.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_02.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_03.jpg.001.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_03.jpg.001.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_03.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_03.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_03.png.002.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_03.png.002.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_03_n.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_03_n.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_04.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_04.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_01.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_01.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_02.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_02.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_03.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_03.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_04.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_04.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_05.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_05.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_06.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_06.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_07.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_07.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_08.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ISS_AO_08.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/ecostress.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/ecostress.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/foil_n.jpg.png b/assets/Environments/InternationalSpaceStation/textures/ISS/foil_n.jpg.png
diff --git a/assets/Environments/InternationalSpaceStation/textures/ISS/foil_n.png.png b/assets/Environments/InternationalSpaceStation/textures/ISS/foil_n.png.png
diff --git a/...vironments/InternationalSpaceStation/textures/ISSInternal/Airlock_1_Diffuse.png b/...vironments/InternationalSpaceStation/textures/ISSInternal/Airlock_1_Diffuse.png
diff --git a/...nvironments/InternationalSpaceStation/textures/ISSInternal/Airlock_1_Normal.png b/...nvironments/InternationalSpaceStation/textures/ISSInternal/Airlock_1_Normal.png
diff --git a/...vironments/InternationalSpaceStation/textures/ISSInternal/Airlock_2_Diffuse.png b/...vironments/InternationalSpaceStation/textures/ISSInternal/Airlock_2_Diffuse.png
diff --git a/...nvironments/InternationalSpaceStation/textures/ISSInternal/Airlock_2_Normal.png b/...nvironments/InternationalSpaceStation/textures/ISSInternal/Airlock_2_Normal.png
diff --git a/...nvironments/InternationalSpaceStation/textures/ISSInternal/BEAM_Int_Diffuse.png b/...nvironments/InternationalSpaceStation/textures/ISSInternal/BEAM_Int_Diffuse.png
diff --git a/...Environments/InternationalSpaceStation/textures/ISSInternal/BEAM_Int_Normal.png b/...Environments/InternationalSpaceStation/textures/ISSInternal/BEAM_Int_Normal.png
diff --git a/.../Environments/InternationalSpaceStation/textures/ISSInternal/Bishop_Diffuse.png b/.../Environments/InternationalSpaceStation/textures/ISSInternal/Bishop_Diffuse.png
diff --git a/...s/Environments/InternationalSpaceStation/textures/ISSInternal/Bishop_Normal.png b/...s/Environments/InternationalSpaceStation/textures/ISSInternal/Bishop_Normal.png
diff --git a/...nternationalSpaceStation/textures/ISSInternal/Columbus_Int_Bulkhead_Diffuse.png b/...nternationalSpaceStation/textures/ISSInternal/Columbus_Int_Bulkhead_Diffuse.png
diff --git a/...InternationalSpaceStation/textures/ISSInternal/Columbus_Int_Bulkhead_Normal.png b/...InternationalSpaceStation/textures/ISSInternal/Columbus_Int_Bulkhead_Normal.png
diff --git a/...nts/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks01_Diffuse.png b/...nts/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks01_Diffuse.png
diff --git a/...ents/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks01_Normal.png b/...ents/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks01_Normal.png
diff --git a/...nts/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks02_Diffuse.png b/...nts/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks02_Diffuse.png
diff --git a/...ents/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks02_Normal.png b/...ents/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks02_Normal.png
diff --git a/...nts/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks03_Diffuse.png b/...nts/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks03_Diffuse.png
diff --git a/...ents/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks03_Normal.png b/...ents/InternationalSpaceStation/textures/ISSInternal/Columbus_Racks03_Normal.png
diff --git a/...ironments/InternationalSpaceStation/textures/ISSInternal/Cupola_Int_Diffuse.png b/...ironments/InternationalSpaceStation/textures/ISSInternal/Cupola_Int_Diffuse.png
diff --git a/...vironments/InternationalSpaceStation/textures/ISSInternal/Cupola_Int_Normal.png b/...vironments/InternationalSpaceStation/textures/ISSInternal/Cupola_Int_Normal.png
diff --git a/.../InternationalSpaceStation/textures/ISSInternal/EXPRESS_Racks_ATLAS_Diffuse.png b/.../InternationalSpaceStation/textures/ISSInternal/EXPRESS_Racks_ATLAS_Diffuse.png
diff --git a/...s/InternationalSpaceStation/textures/ISSInternal/EXPRESS_Racks_ATLAS_Normal.png b/...s/InternationalSpaceStation/textures/ISSInternal/EXPRESS_Racks_ATLAS_Normal.png
diff --git a/...InternationalSpaceStation/textures/ISSInternal/Generic_HubAndMetals_Diffuse.png b/...InternationalSpaceStation/textures/ISSInternal/Generic_HubAndMetals_Diffuse.png
diff --git a/.../InternationalSpaceStation/textures/ISSInternal/Generic_HubAndMetals_Normal.png b/.../InternationalSpaceStation/textures/ISSInternal/Generic_HubAndMetals_Normal.png
diff --git a/...InternationalSpaceStation/textures/ISSInternal/Generic_Misc_Details_Diffuse.png b/...InternationalSpaceStation/textures/ISSInternal/Generic_Misc_Details_Diffuse.png
diff --git a/...nts/InternationalSpaceStation/textures/ISSInternal/JLP_Int_Bulkhead_Diffuse.png b/...nts/InternationalSpaceStation/textures/ISSInternal/JLP_Int_Bulkhead_Diffuse.png
diff --git a/...ents/InternationalSpaceStation/textures/ISSInternal/JLP_Int_Bulkhead_Normal.png b/...ents/InternationalSpaceStation/textures/ISSInternal/JLP_Int_Bulkhead_Normal.png
diff --git a/...vironments/InternationalSpaceStation/textures/ISSInternal/JLP_Racks_Diffuse.png b/...vironments/InternationalSpaceStation/textures/ISSInternal/JLP_Racks_Diffuse.png
diff --git a/...nvironments/InternationalSpaceStation/textures/ISSInternal/JLP_Racks_Normal.png b/...nvironments/InternationalSpaceStation/textures/ISSInternal/JLP_Racks_Normal.png
diff --git a/...onments/InternationalSpaceStation/textures/ISSInternal/JPM_Bulkhead_Diffuse.png b/...onments/InternationalSpaceStation/textures/ISSInternal/JPM_Bulkhead_Diffuse.png
diff --git a/...ronments/InternationalSpaceStation/textures/ISSInternal/JPM_Bulkhead_Normal.png b/...ronments/InternationalSpaceStation/textures/ISSInternal/JPM_Bulkhead_Normal.png
diff --git a/...onments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_01_Diffuse.png b/...onments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_01_Diffuse.png
diff --git a/...ronments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_01_Normal.png b/...ronments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_01_Normal.png
diff --git a/...onments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_02_Diffuse.png b/...onments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_02_Diffuse.png
diff --git a/...ronments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_02_Normal.png b/...ronments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_02_Normal.png
diff --git a/...onments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_03_Diffuse.png b/...onments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_03_Diffuse.png
diff --git a/...ronments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_03_Normal.png b/...ronments/InternationalSpaceStation/textures/ISSInternal/JPM_Racks_03_Normal.png
diff --git a/...nments/InternationalSpaceStation/textures/ISSInternal/NewRacks59-60_Diffuse.png b/...nments/InternationalSpaceStation/textures/ISSInternal/NewRacks59-60_Diffuse.png
diff --git a/...onments/InternationalSpaceStation/textures/ISSInternal/NewRacks59-60_Normal.png b/...onments/InternationalSpaceStation/textures/ISSInternal/NewRacks59-60_Normal.png
diff --git a/...s/InternationalSpaceStation/textures/ISSInternal/Node2_Int_Bulkhead_Diffuse.png b/...s/InternationalSpaceStation/textures/ISSInternal/Node2_Int_Bulkhead_Diffuse.png
diff --git a/...ts/InternationalSpaceStation/textures/ISSInternal/Node2_Int_Bulkhead_Normal.png b/...ts/InternationalSpaceStation/textures/ISSInternal/Node2_Int_Bulkhead_Normal.png
diff --git a/...ments/InternationalSpaceStation/textures/ISSInternal/Node2_Int_Rack_Diffuse.png b/...ments/InternationalSpaceStation/textures/ISSInternal/Node2_Int_Rack_Diffuse.png
diff --git a/...nments/InternationalSpaceStation/textures/ISSInternal/Node2_Int_Rack_Normal.png b/...nments/InternationalSpaceStation/textures/ISSInternal/Node2_Int_Rack_Normal.png
diff --git a/...s/InternationalSpaceStation/textures/ISSInternal/Node3_Int_Bulkhead_Diffuse.png b/...s/InternationalSpaceStation/textures/ISSInternal/Node3_Int_Bulkhead_Diffuse.png
diff --git a/...ts/InternationalSpaceStation/textures/ISSInternal/Node3_Int_Bulkhead_Normal.png b/...ts/InternationalSpaceStation/textures/ISSInternal/Node3_Int_Bulkhead_Normal.png