Files
TheRock/rocm-systems/projects/hip/docs/install/install.rst
T
derek.holloway 7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
Flatten subprojects into a single base monorepo
2026-09-02 16:34:47 -07:00

104 lines
3.1 KiB
ReStructuredText

.. meta::
:description: This page explains how to install HIP
:keywords: AMD, ROCm, HIP, install, installation
*******************************************
Install HIP
*******************************************
HIP can be installed on AMD platforms using ROCm with HIP-Clang.
.. _install_prerequisites:
Prerequisites
=======================================
Before you begin, verify that your system is supported. For more information,
see :ref:`ROCm Core SDK components <rocm:release-components>`.
For advanced workflows, source builds, or custom configurations, see
:doc:`./build`.
Install the ROCm Core SDK
=======================================
The HIP runtime is included with the ROCm Core SDK on Linux and Windows. For
the most complete installation, we recommend that developers use the
``amdrocm-core-sdk`` meta package.
For instructions, see :doc:`Install AMD ROCm <rocm:install/rocm>`. Use the
selector panel on that page to view instructions appropriate for your system
environment.
.. note::
By default, when installing using your Linux distribution's package manager,
HIP is installed into ``/opt/rocm``.
There is no autodetection for the HIP installation. If you choose to
install it somewhere other than the default location, you must set the
``HIP_PATH`` environment variable as explained in
:doc:`Build HIP from source <./build>`.
Install the ROCm runtime on Linux
=================================
Alternatively, if you want to install the ROCm runtime package without
additional ROCm libraries and tools, install the ``amdrocm-runtime`` package.
This includes the HIP, base ROCm packages, and the compiler ecosystem.
1. Complete the :doc:`ROCm installation prerequisites <rocm:install/rocm>` to
install dependencies and configure GPU access permissions.
2. Install the ROCm runtime package that matches your desired ROCm version.
Package names use the following format:
.. code-block:: shell-session
amdrocm-runtime<rocm_version>
Where ``<rocm_version>`` is the ROCm Core SDK version to install. Omit this
suffix to install the latest available version.
For example, to install the latest ROCm runtime package release for
supported GPU architectures:
.. tab-set::
.. tab-item:: Debian-based distros
.. code-block:: bash
sudo apt install amdrocm-runtime
.. tab-item:: RHEL-based distros
.. code-block:: bash
sudo dnf install amdrocm-runtime
.. tab-item:: SLES
.. code-block:: bash
sudo zypper install amdrocm-runtime
.. _install-nightly:
Install a nightly build
=======================
The `TheRock <https://github.com/ROCm/TheRock>`__ build system also publishes
nightly builds for the ROCm Core SDK and its components, including the HIP
runtime. See `Nightly release status
<https://github.com/ROCm/TheRock#nightly-release-status>`__ for details.
Verify your installation
==========================================================
Run ``hipconfig`` in your installation path.
.. code-block:: shell
/opt/rocm/bin/hipconfig --full