NVIDIA GPUs htop like monitoring tool
Switch branches/tags
Clone or download
Latest commit 7affdc8 Sep 16, 2018
Permalink
Failed to load latest commit information.
cmake nvml header search location Aug 19, 2018
include Fahrenheit option Oct 20, 2018
manpage Fahrenheit option Oct 20, 2018
screenshot Add README Jun 16, 2017
src Fahrenheit option Oct 20, 2018
.gitignore Initial commit Jun 16, 2017
CMakeLists.txt Bump version to 0.2.3 Sep 12, 2018
COPYING Initial commit Jun 16, 2017
LICENSE Initial commit Jun 16, 2017
README.markdown fixed sufficient Oct 9, 2018
TODO Todo update Mar 29, 2018

README.markdown

NVTOP

What is NVTOP?

Nvtop stands for NVidia TOP, a (h)top like task monitor for NVIDIA GPUs. It can handle multiple GPUs and print information about them in a htop familiar way.

Because a picture is worth a thousand words:

NVTOP interface

Table of Contents

  1. NVTOP Options and Interactive Commands
  2. GPU Support
  3. Build
    1. Ubuntu / Debian
    2. Fedora / RedHat / CentOS
    3. OpenSUSE
    4. Arch Linux
    5. NVTOP Build
  4. License

NVTOP Options and Interactive Commands

NVTOP comes with a manpage!

man nvtop

For quick command line arguments help

nvtop -h
nvtop --help

GPU Support

The NVML library does not support some of the queries for GPUs coming before the Kepler microarchitecture. Anything starting at GeForce 600, GeForce 800M and successor should work fine. For more information about supported GPUs please take a look at the NVML documentation.

Build

Two libraries are required:

  • The NVIDIA Management Library (NVML) which comes with the GPU driver.
    • This queries the GPU for information.
  • The ncurses library driving the user interface.
    • This makes the screen look beautiful.

Distribution Specific Installation Process

Ubuntu / Debian

Fedora / RedHat / CentOS

  • NVIDIA drivers, CUDA required for nvml libraries (see RPM Fusion)
  • CMake, ncurses and git
    sudo dnf install cmake ncurses-devel git
  • NVTOP

OpenSUSE

Arch Linux

  • NVIDIA drivers (see Arch Linux wiki)
  • CMake, ncurses and git
    sudo pacman -S cmake ncurses git
  • NVTOP

NVTOP Build

git clone https://github.com/Syllo/nvtop.git
mkdir -p nvtop/build && cd nvtop/build
cmake ..

# If it errors with "Could NOT find NVML (missing: NVML_INCLUDE_DIRS)"
# try the following command instead, otherwise skip to the build with make.
cmake .. -DNVML_RETRIEVE_HEADER_ONLINE=True

make
make install # You may need sufficient permission for that (root)

The build system supports multiple build type (e.g. -DCMAKE_BUILD_TYPE=Optimized):

  • Release: Binary without debug information
  • RelWithDebInfo: Binary with debug information
  • Debug: Compile with warning flags and address/undefined sanitizers enabled (for development purposes)
  • Optimized: Build with architecture specific optimizations enabled (may not be portable across processor architectures)

License

Nvtop is licensed under the GPLV3 license or any later version. You will find a copy of the license inside the COPYING file of the repository or at the gnu website <www.gnu.org/licenses/>.