Skip to content

DOC: Improve docs for installing dependencies #17

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

Open
khalford wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC: Improve docs for installing dependencies #17

Show file tree
Hide file tree
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
31 changes: 17 additions & 14 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
## Pre-Installation Instructions

### 1. **Set Up Ubuntu VM**:
- Start with an Ubuntu VM equipped with Nvidia GPUs.

### 2. **Install Dependencies**:

- **For Docker Benchmarks**: Install Docker, Nvidia Docker (for GPU support), git, Python with Virtual Environment, and Nvidia drivers.

- **For Direct Machine Benchmarks**: Install Tmux, git, Python with Virtual Environment, and Nvidia drivers.

### 3. **Setup VM With Script (requires git to clone repo)**:

- **Docker Benchmarks**: Execute `./setup_vm_docker.sh` from the cloned Git repository.

- **Direct Machine Benchmarks**: Execute `./setup_vm_tmux.sh` from the cloned Git repository.
1. Build a VM in OpenStack with:
- Image: `ubuntu-jammy-22.04-nogui` or `ubuntu-noble-24.04-nogui`
- Flavor: Any `g-*` flavor with an NVIDIA GPU
- Your key pair for SSH access
- Accessible networking: Internal or Private with FIP

2. Use [this](https://www.nvidia.com/en-gb/drivers/) NVIDIA page to find the latest driver for your VMs GPU and note the number e.g. 590

3. Install Dependencies:
```shell
git clone https://github.com/stfc/iris-bench.git
cd iris-bench
# For using Docker containers to benchmark:
./setup_vm_docker.sh <nvidia-driver-version>
# For direct machine benchmarking:
./setup_vm_tmux.sh <nvidia-driver-version>
```

---

Expand Down
10 changes: 9 additions & 1 deletion setup_vm_docker.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@
# software for IrisBench and Docker benchmarks.
# =============================================================================

# Get Nvidia driver version from first argument to script
NVIDIA_DRIVER_VERSION=$1

if [ -z "$NVIDIA_DRIVER_VERSION" ] ;then
echo "Please provide the Nvidia driver version. e.g. ./setup_vm_docker.sh <nvidia-driver-version>"
exit
fi


##### INSTALL OFFICAL DOCKER #####

Expand Down Expand Up @@ -82,7 +90,7 @@ echo -e "/n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~/nINSTALL NVIDIA DRIVERS/n~~~~~~~~~~~~

# Install NVIDIA drivers (if needed)
# Ensure the driver is up-to-date for the GPU to achieve maximum performance.
sudo apt install -y nvidia-driver-535
sudo apt install -y "nvidia-driver-${NVIDIA_DRIVER_VERSION}"

##### REBOOT VM #####

Expand Down
10 changes: 9 additions & 1 deletion setup_vm_tmux.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@
# Tmux, and NVIDIA drivers.
# =============================================================================

# Get Nvidia driver version from first argument to script
NVIDIA_DRIVER_VERSION=$1

if [ -z "$NVIDIA_DRIVER_VERSION" ] ;then
echo "Please provide the Nvidia driver version. e.g. ./setup_vm_tmux.sh <nvidia-driver-version>"
exit
fi

#### INSTALL Git, python3-pip and Venv ###

echo -e "/n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~/nInstall git, python3-pip, and Venv/n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~/n"
Expand All @@ -33,7 +41,7 @@ echo -e "/n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~/nINSTALL NVIDIA DRIVERS/n~~~~~~~~~~~~

# Install NVIDIA drivers (if needed)
# Ensure the driver is up-to-date for the GPU to achieve maximum performance.
sudo apt install -y nvidia-driver-535
sudo apt install -y "nvidia-driver-${NVIDIA_DRIVER_VERSION}"

##### REBOOT VM #####

Expand Down