Skip to content

Commit c105553

Browse files
authored
Update README.md
1 parent 1487893 commit c105553

1 file changed

Lines changed: 34 additions & 10 deletions

File tree

README.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,43 @@
11
# Dockerfile for Accel-Sim
22

3-
This repo hosts the Dockerfiles used in regression tests for Accel-Sim and GPGPU-Sim.
4-
The image can be pull from Github Container Registry [accelsim cantainers](https://github.com/accel-sim/Dockerfile/pkgs/container/accel-sim-framework)
5-
```
3+
This repository hosts the Dockerfiles used in regression tests for **Accel-Sim** and **GPGPU-Sim**.
4+
Prebuilt images are available on the GitHub Container Registry: [accel-sim containers](https://github.com/accel-sim/Dockerfile/pkgs/container/accel-sim-framework)
5+
6+
## Requirements
7+
To enable GPU access inside Docker containers, you need to install the **NVIDIA Container Toolkit**.
8+
Follow the installation guide here: [NVIDIA Container Toolkit Install Guide](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
9+
10+
---
11+
12+
## Pull the image
13+
```bash
614
docker pull ghcr.io/accel-sim/accel-sim-framework:ubuntu-24.04-cuda-12.8
715
```
816

9-
To run tests:
10-
```
11-
# in accel-sim-framework
12-
docker run accelsim/development:cuda-12.8.0-ubuntu24.04 /bin/bash short-tests.sh
17+
## Run regression tests
18+
From inside `accel-sim-framework`:
19+
```bash
20+
docker run ghcr.io/accel-sim/accel-sim-framework:ubuntu-24.04-cuda-12.8 /bin/bash short-tests.sh
1321
```
14-
To start conianer for devlopment:
1522

23+
## Start a container for development
24+
```bash
25+
docker run --name <container_name> --runtime=nvidia --gpus all -it \
26+
ghcr.io/accel-sim/accel-sim-framework:ubuntu-24.04-cuda-12.8 /bin/bash
1627
```
17-
# in accel-sim-framework
18-
docker run --name <container name > --runtime=nvidia --gpus all -it ghcr.io/accel-sim/accel-sim-framework:ubuntu-24.04-cuda-12.8 /bin/bash
28+
29+
## Build the image locally
30+
If you want to modify the Dockerfile and build your own image:
31+
```bash
32+
# from the directory containing the Dockerfile
33+
docker build -t accelsim/dev:local .
1934
```
35+
36+
37+
---
38+
39+
## Notes
40+
- Replace `<container_name>` with a descriptive name for your container.
41+
- The `--runtime=nvidia --gpus all` flags ensure GPU access inside the container (requires NVIDIA Container Toolkit).
42+
- Use the local tag `accelsim/dev:local` when running your custom build.
43+

0 commit comments

Comments
 (0)