Skip to content

Commit

Permalink
Small tweaks to READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
sea-bass committed Oct 31, 2023
1 parent c60ab97 commit d9d0cf8
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 14 deletions.
12 changes: 9 additions & 3 deletions moveit2/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# MoveIt2 Docker Image

The MoveIt2 Docker image uses the Space ROS docker image (*openrobotics/spaceros:latest*) as its base image. The MoveIt2 Dockerfile installs all of the prerequisite system dependencies to build MoveIt2 (and Moveit2 tutorials) and then pulls and builds the latest MoveIt2 and Moveit2 tutorials source code.
The MoveIt2 Docker image uses the Space ROS docker image (*openrobotics/spaceros:latest*) as its base image.
The MoveIt2 Dockerfile installs all of the prerequisite system dependencies to build MoveIt2 (and Moveit2 tutorials) and then pulls and builds the latest MoveIt2 and Moveit2 tutorials source code.

## Building the MoveIt2 Image

Expand Down Expand Up @@ -37,7 +38,8 @@ There is a run.sh script provided for convenience that will run the spaceros ima
$ ./run.sh
```

Upon startup, the container automatically runs the entrypoint.sh script, which sources the MoveIt2 and Space ROS environment files. You'll now be running inside the container and should see a prompt similar to this:
Upon startup, the container automatically runs the entrypoint.sh script, which sources the MoveIt2 and Space ROS environment files.
You'll now be running inside the container and should see a prompt similar to this:

```
spaceros-user@8e73b41a4e16:~/moveit2#
Expand All @@ -55,7 +57,7 @@ You should see lots of console output and the rviz2 window appear:

![rviz2 tutorial window](resources/moveit2-rviz-tutorial.png)

You can now following the [MoveIt2 Tutorial documentation](https://moveit.picknik.ai/main/doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial.html).
You can now follow the [MoveIt2 Tutorial documentation](https://moveit.picknik.ai/main/doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial.html).

## Running the MoveIt2 Move Group C++ Interface Demo

Expand All @@ -68,3 +70,7 @@ ros2 launch moveit2_tutorials move_group.launch.py
![rviz2 move group window](resources/moveit2-rviz.png)

Then, you can follow the [Move Group C++ Interface Demo documentation](https://moveit.picknik.ai/humble/doc/examples/move_group_interface/move_group_interface_tutorial.html).

## Running the Space ROS Space Robots Demos

Once you have tested that MoveIt2 works, you are ready to run some of the other [Space ROS space robot demos](../space_robots/README.md).
13 changes: 7 additions & 6 deletions space_robots/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Space ROS Space Robots Demo Docker Image

The Space ROS Space Robots Demo docker image uses the moveit2 docker image (*openrobotics/moveit2:latest*) as its base image. Build instructions for that image can be found at [docker/moveit2/README.md](https://github.com/space-ros/docker/blob/main/moveit2/README.md). The Dockerfile installs all of the prerequisite system dependencies along with the demos source code, then builds the Space ROS Space Robots Demo.
The Space ROS Space Robots Demo docker image uses the moveit2 docker image (*openrobotics/moveit2:latest*) as its base image.
Build instructions for that image can be found in [this README](../moveit2/README.md).
The Dockerfile installs all of the prerequisite system dependencies along with the demos source code, then builds the Space ROS Space Robots Demo.

This is for Curiosity Mars rover and Canadarm demos.

## Building the Demo Docker

The demo image builds on top of the `spaceros` and `moveit2` images. To build the docker image, first build both required images, then the `space_robots` demo image:
The demo image builds on top of the `spaceros` and `moveit2` images.
To build the docker image, first build both required images, then the `space_robots` demo image:

```
$ cd docker/spaceros
Expand All @@ -29,7 +32,7 @@ Then run:
$ ./run.sh
```

Depending on the host computer, you might need to remove ```--gpus all``` flag in ```run.sh```, which uses your GPUs.
Depending on the host computer, you might need to remove the ```--gpus all``` flag in ```run.sh```, which uses your GPUs.

## Running the Demos

Expand All @@ -41,8 +44,6 @@ $ ros2 launch mars_rover mars_rover.launch.py

On the top left corner, click on the refresh button to show camera feed.

### Perform Tasks

#### Setup

Open a new terminal and attach to the currently running container:
Expand Down Expand Up @@ -111,7 +112,7 @@ Close the mast (camera arm)
$ ros2 service call /mast_close std_srvs/srv/Empty
```

#### Canadarm demo
### Canadarm demo

```
$ ros2 launch canadarm canadarm.launch.py
Expand Down
10 changes: 5 additions & 5 deletions spaceros/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,14 @@ There is a run.sh script provided for convenience that will run the spaceros ima
$ ./run.sh
```

Upon startup, the container automatically runs the entrypoint.sh script, which sources the Space ROS environment file (setup.bash). You'll now be running inside the container and should see a prompt similar to this:
Upon startup, the container automatically runs the entrypoint.sh script, which sources the Space ROS environment file (setup.bash).
You'll now be running inside the container and should see a prompt similar to this:

```
spaceros-user@d10d85c68f0e:~/spaceros$
```

At this point, you can run the 'ros2' command line utility to make sure everything is working OK:
At this point, you can run the `ros2` command line utility to make sure everything is working OK:

```
spaceros-user@d10d85c68f0e:~/spaceros$ ros2
Expand Down Expand Up @@ -215,10 +216,9 @@ To generate a JUnit XML file for a specific package only, you can add the *--pac
spaceros-user@d10d85c68f0e:~/spaceros$ colcon test --build-base build_ikos --install-base install_ikos --packages-select rcpputils
```

The 'colcon test' command runs various tests, including IKOS report generation, which reads the IKOS database generated in the previous analysis step and generates a JUnit XML report file. After running 'colcon test', you can view the JUnit XML files. For example, to view the JUnit XML file for IKOS scan of the rcpputils binaries you can use the following command:
The 'colcon test' command runs various tests, including IKOS report generation, which reads the IKOS database generated in the previous analysis step and generates a JUnit XML report file.
After running 'colcon test', you can view the JUnit XML files. For example, to view the JUnit XML file for IKOS scan of the rcpputils binaries you can use the following command:

```
spaceros-user@d10d85c68f0e:~/spaceros$ more build_ikos/rcpputils/test_results/rcpputils/ikos.xunit.xml
```

0 comments on commit d9d0cf8

Please sign in to comment.