Installing hipCIM

Installing hipCIM#

2025-12-10

5 min read time

Applies to Linux

This topic discusses how to install hipCIM using the following options:

Build from source (for developers)
Recommended: AMD PyPI (for users)

System requirements#

ROCm version	Ubuntu version	Python version	AMD Instinct GPU
7.0.2	24.04	3.12	MI300A
6.4.3	22.04	3.10	MI325X

Setting up the environment#

To set up the environment for installing hipCIM, follow these steps:

Optional: Use ROCm Docker to get started.

For ROCm 7.0.2, run:

docker run --cap-add=SYS_PTRACE --ipc=host --privileged=true   \
--shm-size=128GB --network=host --device=/dev/kfd     \
--device=/dev/dri --group-add video -it               \
-v $HOME:$HOME  --name ${LOGNAME}_rocm                \
                                 rocm/dev-ubuntu-24.04:7.0.2-complete

For ROCm 6.4.3, run:

docker run --cap-add=SYS_PTRACE --ipc=host --privileged=true   \
--shm-size=128GB --network=host --device=/dev/kfd     \
--device=/dev/dri --group-add video -it               \
-v $HOME:$HOME  --name ${LOGNAME}_rocm                \
                                 rocm/dev-ubuntu-22.04:6.4.3-complete

For bare metal, skip this step.

Install system dependencies. For both ROCm 6.4.3 and 7.0.2, run:

apt-get update && \
apt-get install -y software-properties-common lsb-release gnupg && \
apt-key adv --fetch-keys https://apt.kitware.com/keys/kitware-archive-latest.asc && \
add-apt-repository -y "deb https://apt.kitware.com/ubuntu/ $(lsb_release -cs) main" && \
mkdir -p /etc/apt/keyrings && \
curl -fsSL https://repo.radeon.com/rocm/rocm.gpg.key | gpg --dearmor -o /etc/apt/keyrings/rocm.gpg && \
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/rocm.gpg] https://repo.radeon.com/amdgpu/6.2.1/ubuntu jammy main proprietary" | tee /etc/apt/sources.list.d/amdgpu.list && \
apt-get update && \
apt-get install -y git wget gcc g++ ninja-build git-lfs \
               yasm libopenslide-dev python3 python3-venv \
               python3-dev libpython3-dev \
               cmake rocjpeg rocjpeg-dev rocthrust-dev \
               hipcub hipblas hipblas-dev hipfft hipsparse \
               hiprand rocsolver rocrand-dev rocm-hip-sdk

Create the Python virtual environment.

python3 -m venv hipcim_dev
source hipcim_dev/bin/activate

Set the environment variables:

export ROCM_HOME=/opt/rocm
export AMDGPU_TARGETS=gfx942

Building hipCIM from source#

To build hipCIM from source, follow the steps given in this section. hipCIM developers should use this installation method. hipCIM users should use the Installing hipCIM using AMD PyPI

Install dependencies.
```
pip install --upgrade pip
```
Download the latest version of hipCIM from the git repository.
```
git clone git@github.com:ROCm-LS/hipCIM.git
cd hipCIM
```
Install the rest of the dependencies.
```
pip install -r ./requirements.txt
```

Build and install hipCIM.

To build the hipCIM library on a ROCm-based AMD system using the development environment, follow these steps:

Build the base C++ libraries.
```
./run_amd build_local cpp release
```
Build the Python bindings.
```
./run_amd build_local hipcim release
```

Install the Python bindings.

# For ROCm 7.0.2
python3 -m pip install python/cucim --extra-index-url https://pypi.amd.com/rocm-7.0.2/simple/

# For ROCm 6.4.3
python3 -m pip install python/cucim --extra-index-url https://pypi.amd.com/simple

Verify the installation.

To verify the installation, follow these steps:
1. Execute the tests in the base C++ libraries.
```
./run_amd test cpp release
```
2. Execute the Python tests.
```
./run_amd test_python
```