forked from space-ros/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added page in docs for lunar sim and instructions on how to build and…
… run it (issue space-ros/demos#50)
- Loading branch information
Munir Azme
committed
Sep 9, 2024
1 parent
0ad2383
commit 750fc33
Showing
2 changed files
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
Lunar Sim Demo | ||
============== | ||
|
||
Space ROS Lunar Sim Demo Docker Image | ||
------------------------------------- | ||
|
||
The Space ROS Lunar Sim Demo docker image uses the spaceros docker image (*osrf/space-ros:latest*) as its base image. | ||
The Dockerfile installs all of the prerequisite system dependencies along with the demo source code, then builds the Space ROS Lunar Sim Demo. | ||
|
||
This demo includes a Gazebo simulation of the lunar environment (specfically around the Shackleton crater near the south pole). It uses | ||
Digital Elevation Models (DEMs) from the Lunar Orbiter Laser Altimeter (LOLA) to accurately simulate the lunar surface in a specific region. It also contains a dynamic model of the Sun that moves according to Ephemeris data. | ||
|
||
Building the Demo Docker | ||
^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
The demo image builds on top of the spaceros image. | ||
To build the docker image, first ensure the spaceros base image is available either by `building it locally <https://github.com/space-ros/space-ros>`_ or pulling it. | ||
|
||
Then build lunar_sim demo images: | ||
|
||
.. code-block:: bash | ||
cd ../lunar_sim | ||
./build.sh | ||
Running the Demo Docker | ||
^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
Run the following to allow GUI passthrough: | ||
|
||
.. code-block:: bash | ||
xhost +local:docker | ||
Then run: | ||
|
||
.. code-block:: bash | ||
./run.sh | ||
Depending on the host computer, you might need to remove the ``--gpus all`` flag in ``run.sh``, which uses your GPUs. | ||
|