AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Omnitrace sample documentation (#179)

Browse Source 
* Documentation for omnitrace-sample

* Improve omnitrace-sample

- improve the printing of the env updates
- remove env settings when something is deactivated
- restore env settings when something is deactivated
This commit is contained in:
Jonathan R. Madsen
2022-10-19 03:30:00 -05:00
committed by GitHub
parent 78a06e7a42
commit 67f7471253
15 changed files with 789 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/docs/setup.md
+9 -3
View File
@@ -1,4 +1,4 @@
# Setup
# Setup and Validation
```eval_rst
.. toctree::
@@ -8,13 +8,13 @@
## Configuring Environment
Source the `setup-env.sh` script to prefix the `PATH`, `LD_LIBRARY_PATH`, etc. environment variables:
Once omnitrace is installed, source the `setup-env.sh` script to prefix the `PATH`, `LD_LIBRARY_PATH`, etc. environment variables:
```bash
source /opt/omnitrace/share/omnitrace/setup-env.sh
```
Alternatively, if environment modules are supported, add the `<prefix>/share/modulefiles` directory to `MODULEPATH` via:
Alternatively, if environment modules are supported, add the `<prefix>/share/modulefiles` directory to `MODULEPATH`:
```bash
module use /opt/omnitrace/share/modulefiles
@@ -38,6 +38,12 @@ If all the following commands execute successfully with output, then you are rea
```bash
which omnitrace
which omnitrace-avail
which omnitrace-sample
omnitrace --help
omnitrace-avail --all
omnitrace-sample --help
# if built with python support
which omnitrace-python
omnitrace-python --help
```