31610c7472
* Updated the readme file to point to the official documentation * first commit of new documentation structure * split up and reconfigured Using rocJpeg * Updated the readme file to point to the official documentation * first commit of new documentation structure * split up and reconfigured Using rocJpeg * fixed missing space * All changes asked for in the PR except the Destroy Handles part. * separated creating and destroying handles; added a destroying handles section; added links to hipmalloc() and hipfree() * removed the installation and build sections so that it doesn't conflict/go out of sync with the official doc * putting readme back the way it was, minus documentation section * changed some wording around hipFree()
43 lines
1.7 KiB
ReStructuredText
43 lines
1.7 KiB
ReStructuredText
.. meta::
|
|
:description: Install rocJPEG with the source code
|
|
:keywords: install, building, rocJPEG, AMD, ROCm, source code, developer
|
|
|
|
********************************************************************
|
|
Building and installing rocJPEG from source code
|
|
********************************************************************
|
|
|
|
These instructions are for building rocJPEG from its source code. If you will not be contributing to the rocJPEG code base or previewing features, `package installers <https://rocm.docs.amd.com/projects/rocJPEG/en/latest/install/rocjpeg-package-install.html>`_ are available.
|
|
|
|
.. note::
|
|
|
|
ROCm 6.3.0 or later must be installed before installing rocJPEG. See `Quick start installation guide <https://rocm.docs.amd.com/projects/install-on-linux/en/latest/install/quick-start.html>`_ for detailed ROCm installation instructions.
|
|
|
|
Use `rocJPEG-setup.py <https://github.com/ROCm/rocJPEG/blob/develop/rocJPEG-setup.py>`_ available from the rocJPEG GitHub repo to install the prerequisites:
|
|
|
|
.. code:: shell
|
|
|
|
python rocJPEG-setup.py --rocm_path [ ROCm Installation Path - optional (default:/opt/rocm)]
|
|
|
|
Build and install rocJPEG using the following commands:
|
|
|
|
.. code:: shell
|
|
|
|
git clone https://github.com/ROCm/rocJPEG.git
|
|
cd rocJPEG
|
|
mkdir build && cd build
|
|
cmake ../
|
|
make -j8
|
|
sudo make install
|
|
|
|
After installation, the rocJPEG libraries will be copied to ``/opt/rocm/lib`` and the rocJPEG header files will be copied to ``/opt/rocm/include/rocjpeg``.
|
|
|
|
Install the CTest module:
|
|
|
|
.. code:: shell
|
|
|
|
mkdir rocjpeg-test && cd rocjpeg-test
|
|
cmake /opt/rocm/share/rocjpeg/test/
|
|
ctest -VV
|
|
|
|
To test your build, run ``make test``. To run the test with the verbose option, run ``make test ARGS=\"-VV\"``.
|