Skip to content

Updated the build and prereq docs #471

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
spolifroni-amd wants to merge 4 commits into
base: develop
Choose a base branch
from
+10 −40
Open

Updated the build and prereq docs #471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ce82fd3
removed the pypackage install option
spolifroni-amd Apr 30, 2026
5d1fb01
Merge branch 'develop' into spolifroni-amd/update-rocal-build-instruc…
spolifroni-amd Apr 30, 2026
de7d1c0
Update docs/install/rocAL-build-and-install.rst
spolifroni-amd Apr 30, 2026
52cbd69
updated based on review comments
spolifroni-amd Apr 30, 2026
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
36 changes: 8 additions & 28 deletions docs/install/rocAL-build-and-install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,13 @@
Building and installing rocAL from source code
********************************************************************

Before building and installing rocAL, ensure ROCm has been installed with the `AMDGPU installer <https://rocm.docs.amd.com/projects/install-on-linux/en/docs-6.4.1/install/install-methods/amdgpu-installer-index.html>`_ and the ``rocm`` usecase.
Before building and installing rocAL, ensure ROCm is installed.

The rocAL source code is available from `https://github.com/ROCm/rocAL <https://github.com/ROCm/rocAL>`_. Use the rocAL version that corresponds to the installed version of ROCm.
The rocAL source code is available from https://github.com/ROCm/rocAL. The default develop branch is intended for developers who want to contribute to the rocAL project or who want to preview new features.

rocAL supports the HIP backend.
rocAL supports the `HIP backend <https://rocm.docs.amd.com/projects/HIP/en/latest/index.html>`_.

rocAL is installed in the ROCm installation directory by default. If rocAL for both HIP and OpenCL backends will be installed on the system, each version must be installed in its own custom directory and not in the default directory.


You can choose to use the |setup| setup script to install most :doc:`prerequisites <./rocAL-prerequisites>`
You can choose to use the |setup|_ setup script to install most :doc:`prerequisites <./rocAL-prerequisites>`.

.. note::

Expand All @@ -29,36 +26,19 @@ To build and install rocAL, create the ``build`` directory under the ``rocAL`` r
mkdir build
cd build

Use ``cmake`` to generate a makefile:

.. code:: shell

cmake ../

Use the ``-DCMAKE_INSTALL_PREFIX`` directive to set the installation directory. For example:
Use ``cmake`` to generate a makefile. Use the ``-DCMAKE_INSTALL_PREFIX`` directive to set the installation directory. For example:

.. code:: shell

cmake -DCMAKE_INSTALL_PREFIX=/opt/rocAL/


Run make:
Run make to build and install:

.. code:: shell

make

Run ``cmake`` again to generate Python bindings for ``rocal_pybind`` then install:

.. code:: shell

sudo cmake --build . --target PyPackageInstall
make -j8
sudo make install


After the installation, the rocAL files will be installed under ``/opt/rocm/`` unless ``-DCMAKE_INSTALL_PREFIX`` was specified. If ``-DCMAKE_INSTALL_PREFIX`` was specified, the rocAL files will be installed under the specified directory.

To make and run the tests, use ``make test``.

.. |setup| replace:: ``rocAL-setup.py``
.. _openvx: https://github.com/ROCm/rocAL/blob/develop/rocAL-setup.py
.. _setup: https://github.com/ROCm/rocAL/blob/develop/rocAL-setup.py
14 changes: 2 additions & 12 deletions docs/install/rocAL-prerequisites.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,15 @@
rocAL prerequisites
********************************************************************

rocAL requires ROCm running on `GPUs based on the CDNA architecture <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html>`_ installed with the `AMDGPU installer <https://rocm.docs.amd.com/projects/install-on-linux/en/docs-6.4.1/install/install-methods/amdgpu-installer-index.html>`_.

rocAL has been tested on the following Linux environments:

* Ubuntu 22.04 and 24.04
* RHEL 8 and 9
* SLES 15 SP7

See `Supported operating systems <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html#supported-operating-systems>`_ for the complete list of ROCm supported Linux environments.

:doc:`Building rocAL from source <./rocAL-build-and-install>` requires CMake Version 3.10 or later, AMD Clang++ Version 18.0.0 or later, and the following compiler support:
:doc:`Building rocAL from source <./rocAL-build-and-install>` requires CMake 3.10 or later, ``amdclang++`` 18.0.0 or later, and the following compiler support:

* C++17
* OpenMP
* Threads

Most prerequisites are installed with the :doc:`package installer <./rocAL-package-install>`.

When building rocAL from source, the |setup| setup script can be used to install prerequisites:
When building rocAL from source, the |setup|_ setup script can be used to install prerequisites:

.. code:: shell

Expand Down