Skip to content

Update Docker instructions #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thomas-lowe merged 1 commit into from
Feb 14, 2025
Merged

Update Docker instructions #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 25 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,33 @@ This is an open-source research library, a place to release new techniques in ra
## Install using a Pre-built Container

### Docker (Linux, MacOS, Windows)
```console
# Pull the latest image from GitHub Packages
#### Pull the Latest Image
To download the latest image from GitHub Packages, use the following command:
```bash
docker pull ghcr.io/csiro-robotics/raycloudtools:latest
```

#### Run an Interactive Container
To run the container interactively and bind your home directory to a directory inside the container for accessing host files:

#### On Linux/MacOS
```bash
docker run -it --name raycloudtools -v /home/yourusername:/workspace ghcr.io/csiro-robotics/raycloudtools:latest /bin/bash
```

#### On Windows
```bash
docker run -it --name raycloudtools -v C:/Users/YourUsername:/workspace ghcr.io/csiro-robotics/raycloudtools:latest /bin/bash
```
Replace `/home/yourusername` or `C:/Users/YourUsername` with the path to your home directory.

# Run an interactive container (binds all host directories by default)
docker run -it raycloudtools:latest /bin/bash
#### Reusing Container
To restart and attach to the container in the future:
```bash
docker start -ai raycloudtools
```

### Apptainer/Singularity (Linux)
### Apptainer (Linux/HPC)
```console
# Login to GitHub Container Registry (required once)
export CR_PAT=YOUR_GITHUB_TOKEN
Expand Down Expand Up @@ -66,12 +84,12 @@ cmake ..
make
```

To run the rayXXXX tools from anywhere either sudo make install, or place in your ~/bashrc:
To run the rayXXXX tools from anywhere either sudo make install, or place in your ~/.bashrc:
```console
export PATH=$PATH:'source code path'/raycloudtools/build/bin
```

If not there already, add to your ~/bashrc:
If not there already, add to your ~/.bashrc:
'''console
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib
'''
Expand Down
Loading