.. meta::
   :description: Installation instructions for the rocJPEG library
   :keywords: install, jpeg, picture, image, rocm, lib, library,

.. _installation:

***************
Install rocJPEG
***************

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:`./rocjpeg-build-and-install`.

.. _install-rocm:

Install the ROCm Core SDK
=========================

rocJPEG is included with the ROCm Core SDK on Linux. 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.

.. _install-base:

Install rocJPEG on Linux
========================

Alternatively, if you want to install rocJPEG as part of the ROCm
JPEG package (a subset of the ROCm Core SDK ``amdrocm-core-sdk``) without
additional ROCm libraries and tools, install the ``amdrocm-jpeg`` package.
This includes the ROCm runtime and system dependencies.

1. Complete the :doc:`ROCm installation prerequisites <rocm:install/rocm>` to
   install dependencies and configure GPU access permissions.

2. Install the ROCm JPEG package that matches your desired ROCm version.
   Package names use the following format:

   .. code-block:: shell-session

      amdrocm-jpeg-<dev/devel><rocm_version>

   Where:

   * ``<dev/devel>`` specifies whether to install library files and
     headers. Omit this suffix to only install runtime packages.

     * ``-dev`` is used on Debian-based distributions, including Ubuntu.

     * ``-devel`` is used on RPM-based distributions, including RHEL and SLES.

   * ``<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 JPEG package release for
   supported GPU architectures:

   .. tab-set::

      .. tab-item:: Debian-based distros

         .. code-block:: bash

            sudo apt install amdrocm-jpeg-dev

      .. tab-item:: RHEL-based distros

         .. code-block:: bash

            sudo dnf install amdrocm-jpeg-devel

      .. tab-item:: SLES

         .. code-block:: bash

            sudo zypper install amdrocm-jpeg-devel

.. _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 rocJPEG.
See `Nightly release status
<https://github.com/ROCm/TheRock#nightly-release-status>`__ for details.