Skip to content

Commit

Permalink
Document new 3rd party lib build environment variable ESMF_NVML.
Browse files Browse the repository at this point in the history
  • Loading branch information
theurich committed Oct 23, 2023
1 parent 6aff723 commit ec48d68
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions src/doc/ESMF_install.tex
Original file line number Diff line number Diff line change
Expand Up @@ -549,6 +549,41 @@ \subsubsection{MOAB}

\end{description}

\subsubsection{NVML}
\label{sec:NVML}

The NVIDIA Management Library
(\htmladdnormallink{NVML}{https://docs.nvidia.com/deploy/nvml-api/index.html})
can be used to discover NVIDIA GPUs that are accessible at run-time.

\begin{description}

\item[ESMF\_NVML] Possible values: {\tt "ON"}, {\tt "standard"}, {\tt "OFF"} (default).

\begin{description}
\item[{\tt "internal"}/{\tt "ON"}] The NVML dependent code inside of ESMF will
be enabled.
The {\tt ESMF\_NVML\_LIBS} environment variable will be set to
{\tt "-lnvidia-ml"}.

\item[{\tt "OFF"} (default)] Disables NVML dependent code.
\end{description}

\item[ESMF\_NVML\_INCLUDE] Typically not needed. (no default).

Specifies the path where the NVML header files are located.

\item[ESMF\_NVML\_LIBPATH] Typically not needed. (no default).

Specifies the path where the NVML library file is located.

\item[ESMF\_NVML\_LIBS] Typical value: {\tt "-lnvidia-ml"} (no default).

Specifies the linker directives needed to link the NVML library to
the application.

\end{description}

\subsection{ESMF Environment Variables}
\label{EnvironmentVariables}

Expand Down

0 comments on commit ec48d68

Please sign in to comment.