Skip to content

Commit 77fabe0

Browse files
committed
docs: readded docker documentation
1 parent bc8aeb5 commit 77fabe0

File tree

2 files changed

+29
-8
lines changed

2 files changed

+29
-8
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Robot Control Stack
22
RCS is a unified and multilayered robot control interface over a MuJoCo simulation and real world robot currently implemented for the FR3/Panda, xArm7, UR5e and SO101.
3-
## Requirements
4-
We build and test RCS on the latest Debian and on the latest Ubuntu LTS.
53

64
## Installation
5+
We build and test RCS on the latest Debian and on the latest Ubuntu LTS.
6+
77
1. Install the system dependencies:
88
```shell
99
sudo apt install $(cat debian_deps.txt)
@@ -13,11 +13,6 @@ sudo apt install $(cat debian_deps.txt)
1313
python3 -m venv .venv
1414
source .venv/bin/activate
1515
```
16-
alternatively, with Conda:
17-
```shell
18-
conda create -n rcs python=3.11 # Version ensures that python is installed to the environment
19-
conda activate rcs
20-
```
2116
Then, install the package:
2217
```shell
2318
pip install -r requirements_dev.txt
@@ -28,6 +23,8 @@ pip config --site set global.no-build-isolation false
2823
pip install -ve .
2924
```
3025

26+
For a docker deployment see the [docker](docker) folder.
27+
3128
## Usage
3229
The python package is called `rcs`.
3330

@@ -126,7 +123,7 @@ python -m rcs_realsense --help
126123
```
127124

128125
## Developer Documentation
129-
See our documentation page [robot-control-stack.org](https://robot-control-stack.org) for the development documentation.
126+
See [robot-control-stack.org](https://robot-control-stack.org) for the development documentation.
130127

131128

132129
## Citation

docker/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Docker (GUI + GPU + HW add-ons)
2+
3+
**Prereqs:** Docker + docker-compose, X11 on host, NVIDIA driver + NVIDIA Container Toolkit (legacy `runtime: nvidia`).
4+
**Layout:** `docker/Dockerfile`, overrides in `docker/compose/` (`base.yml`, `gui.yml`, `gpu.yml`, `hw.yml`).
5+
6+
## Build the image
7+
`docker-compose -f docker/compose/base.yml build dev`
8+
9+
## (GUI) allow X access (host)
10+
`export XAUTHORITY=${XAUTHORITY:-$HOME/.Xauthority}`
11+
`xhost +local:docker`
12+
13+
## Run container with GUI + GPU + HW and open a shell
14+
`docker-compose -f docker/compose/base.yml -f docker/compose/gui.yml -f docker/compose/gpu.yml -f docker/compose/hw.yml run --rm run bash`
15+
*(Use fewer `-f` files for lighter setups, e.g., GUI+GPU without HW.)*
16+
17+
## Inside the container
18+
`pip install -ve extensions/rcs_fr3`
19+
`cd examples`
20+
`python fr3_env_cartesian_control.py`
21+
22+
## Troubleshooting
23+
- **`nvidia-smi` missing in container:** ensure it exists on host at `/usr/bin/nvidia-smi` (GPU override bind-mounts it).
24+
- **GUI can’t open:** re-run the `xhost` command and confirm `$DISPLAY` is set on the host.

0 commit comments

Comments
 (0)