David Galiffi
032d39f15c
* Update branding in docs * Rename image used in documentation * Update names of code samples. In the code snippets, the "-" is not valid. ex., rocprof-sys_ --> rocprofsys_ * Update ASCII art * update Doxyfile strip_from_path * Add a "Formerly known as" message. * Fixed typo in product name ROCm Systems Profiler, not ROCm Profiler System * Add "Omnitrace" back to the metadata keywords * Update "install via package manager" section * Update paths to user API files * Rename configuration and environment settings * Update Doxyfiles Update publisher name & ID to "AMD". Update bundle ID to "rocprofiler-systems" * Update docs/what-is-rocprof-sys.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/conceptual/data-collection-modes.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/tutorials/video-tutorials.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/conceptual/rocprof-sys-feature-set.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/how-to/configuring-runtime-options.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/how-to/configuring-validating-environment.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/how-to/general-tips-using-rocprof-sys.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/reference/rocprof-sys-glossary.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/reference/development-guide.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/how-to/instrumenting-rewriting-binary-application.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/install/quick-start.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Note that videos were recorded using the "Omnitrace" name. * Rebase and update some file paths * Update paths to doc images * Update Omnitrace references in code snippets * Rename examples still using the "omni" prefix. * Update docs/how-to/performing-causal-profiling.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/how-to/profiling-python-scripts.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/how-to/sampling-call-stack.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/how-to/understanding-rocprof-sys-output.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> * Update docs/install/install.rst Co-authored-by: Jeffrey Novotny <jnovotny@amd.com> --------- Co-authored-by: Peter Park <peter.park@amd.com> Co-authored-by: Jeffrey Novotny <jnovotny@amd.com>
72 linhas
2.4 KiB
ReStructuredText
72 linhas
2.4 KiB
ReStructuredText
.. meta::
|
|
:description: ROCm Systems Profiler environment validation documentation and reference
|
|
:keywords: rocprof-sys, rocprofiler-systems, Omnitrace, ROCm, profiler, environment, tracking, visualization, tool, Instinct, accelerator, AMD
|
|
|
|
****************************************************
|
|
Configuring and validating the environment
|
|
****************************************************
|
|
|
|
After installing `ROCm Systems Profiler <https://github.com/ROCm/rocprofiler-systems>`_, additional steps are required to set up
|
|
and validate the environment.
|
|
|
|
.. note::
|
|
|
|
The following instructions use the installation path ``/opt/rocprofiler-systems``. If
|
|
ROCm Systems Profiler is installed elsewhere, substitute the actual installation path.
|
|
|
|
Configuring the environment
|
|
========================================
|
|
|
|
After ROCm Systems Profiler is installed, source the ``setup-env.sh`` script to prefix the
|
|
``PATH``, ``LD_LIBRARY_PATH``, and other environment variables:
|
|
|
|
.. code-block:: shell
|
|
|
|
source /opt/rocprofiler-systems/share/rocprofiler-systems/setup-env.sh
|
|
|
|
Alternatively, if environment modules are supported, add the ``<prefix>/share/modulefiles`` directory
|
|
to ``MODULEPATH``:
|
|
|
|
.. code-block:: shell
|
|
|
|
module use /opt/rocprofiler-systems/share/modulefiles
|
|
|
|
.. note::
|
|
|
|
As an alternative, the above line can be added to the ``${HOME}/.modulerc`` file.
|
|
|
|
After ROCm Systems Profiler has been added to the ``MODULEPATH``, it can be loaded
|
|
using ``module load rocprofiler-systems/<VERSION>`` and unloaded using ``module unload rocprofiler-systems/<VERSION>``.
|
|
|
|
.. code-block:: shell
|
|
|
|
module load rocprofiler-systems/1.0.0
|
|
module unload rocprofiler-systems/1.0.0
|
|
|
|
.. note::
|
|
|
|
You might also need to add the path to the ROCm libraries to ``LD_LIBRARY_PATH``,
|
|
for example, ``export LD_LIBRARY_PATH=/opt/rocm/lib:${LD_LIBRARY_PATH}``
|
|
|
|
Validating the environment configuration
|
|
========================================
|
|
|
|
If the following commands all run successfully with the expected output,
|
|
then you are ready to use ROCm Systems Profiler:
|
|
|
|
.. code-block:: shell
|
|
|
|
which rocprof-sys
|
|
which rocprof-sys-avail
|
|
which rocprof-sys-sample
|
|
rocprof-sys-instrument --help
|
|
rocprof-sys-avail --all
|
|
rocprof-sys-sample --help
|
|
|
|
If ROCm Systems Profiler was built with Python support, validate these additional commands:
|
|
|
|
.. code-block:: shell
|
|
|
|
which rocprof-sys-python
|
|
rocprof-sys-python --help
|