Installation Guide

Guides on how to install NVIDIA Nsight Graphics.

Windows Installation and Setup

Before you install Nsight Graphics, please make sure that you have prepared your system by completing the following tasks:

Task

For more information, see…

Review the hardware and software requirements for the product to make sure that you have the minimum or recommended configurations.

System Requirements for NVIDIA Nsight Graphics Software

Configure Windows 10 Hybrid mode to use the high-performance NVIDIA GPU for Nsight Graphics.

Setup Hybrid Mode

Walkthrough how to make sure your system is running with the most current NVIDIA graphics driver.

How To: Install the NVIDIA Display Driver

System Requirements

Nsight Graphics™ supports flexible hardware configurations:

  • Single GPU System

  • Dual GPU System

  • Notebook equipped with NVIDIA Optimus technology: The recommended single notebook machine configuration for a GPGPU developer. This configuration supports both the Nsight Graphics Debugger and Analyzer using NVIDIA Optimus technology.

Display Driver

You must install the NVIDIA display driver that supports the Nsight Graphics tools. If you have an NVIDIA graphics card installed on your target machine, you likely already have an NVIDIA display driver; however, Nsight Graphics requires a specific version of the driver in order to function properly.

The required driver version can be found in the Release Notes.

Supported Operating Systems

For the latest updates to the list of supported operating systems, see the full list here.

Supported Graphics Cards

For the latest updates to the list of supported GPUs, see the full GPU list here.

C++ Capture Requirements

C++ Captures require that the host machine have Visual Studio 2019 or newer installed to compile. For Direct3D applications, this version of Visual Studio must have an SDK version that is compatible with the Direct3D SDK usage of the application being captured.

Installing the NVIDIA Display Driver

It is recommended that you install an NVIDIA display driver that Nsight Graphics™ 2024.3 requires. See the Release Notes for more information.

If you have an NVIDIA graphics card installed on your target machine, you probably already have an NVIDIA display driver. However, Nsight Graphics™ requires an updated version of the driver in order to function properly. Please see the latest release notes for instructions on compatible driver versions:

To install the NVIDIA Display Driver:

  1. Run the NVIDIA Display Driver installer.

    The Display Driver Installer appears.

    ../_images/nsight.displaydriver.install.noversion.001.png
  2. Follow installer directions until final screen. Do not reboot.

    ../_images/nsight.displaydriver.finishinstall.noversion.001.png
  3. When prompted, select No, I will restart my computer later.

  4. Click Finish.

See also:

Setup Hybrid Mode

Nsight Graphics™ is able to profile and debug applications on laptops using Windows 10 Hybrid mode. In order to do so, you will need to configure your machine to use the high-performance NVIDIA GPU for Nsight Graphics.

There are two methods to direct an application to use the NVIDIA GPU.

  1. Configure all applications use the NVIDIA GPU.

  2. Configure only specific applications to use the NVIDIA GPU.

The first option is the easiest to control, but may adversely affect overall system performance. The second option is more fine grain and allows the system to maintain lower power.

To get started, right-click on your desktop, and open the NVIDIA Control Panel.

../_images/nvidia_control_panel.001.png

Once the NVIDIA Control Panel has opened, click Manage 3D Settings.

../_images/nvidia_manage_3d_settings.001.png

Option 1: Global Settings

  • On the Global Settings tab, select the drop-down menu under Preferred graphics processor, and select High Performance NVIDIA processor.

  • Click Apply to save the changes. All applications can now be profiled, traced, and debugged in Hybrid mode.

../_images/nvidia_3d_settings_preferred_processor.001.png

Option 2: Program Settings

On the Program Settings tab, you can add each application that should run on the NVIDIA GPU.

  • Under 1. Select a program to customize, press Add to select a running instance of the executable to be debugged, profiled, and/or traced. You may also Browse directly to the location of the desired executable.

    If you plan on running a serialized frame capture, the solution (and built executable) are typically found in:

    C:\Users\<user>\Documents\Nsight Graphics\Captures\<TimeStampedCaptureProcess>
    

    with the built executable in the subdirectory:

    <architecture>\<build>\<TimeStampedCaptureProcess>.exe
    
  • Press Add Selected Program to confirm your selection.

    ../_images/nvidia_3d_program_settings_add_app.001.png
  • Click the drop-down menu under 2. Select the preferred graphics processor for this program:, and select High-performance NVIDIA processor.

  • Click Apply to save the changes. The specified application(s) can now be profiled, traced, and debugged in Hybrid mode.

    ../_images/nvidia_3d_high_perf_gpu_for_nsight.001.png

Linux Installation and Setup

Nsight Graphics™ can be downloaded from the NVIDIA GameWorks Download Center, and is installed as a standalone application.

Host Setup

  1. Run the .run file.

  2. When prompted, accept the license agreement.

    ../_images/linux_install.001.png
  3. Enter a install path.

  4. Specify whether or not you want to create a symlink.

    ../_images/linux_install_symlink.001.png
  5. Complete the installation.

After the installation, the Nsight Graphics GUI host can be found in

<install path>/host/linux-desktop-nomad-x64/ngfx-ui

If installed by .deb installer, you can use this command to start the GUI host

ngfx-ui-for-linux

Note

The .deb package will automatically install the required dependencies. If you are using the .run installer, you may need to install additional dependencies manually. For example, on Ubuntu, the following dependencies are required:

libvulkan1
libzstd1
libc6-dev

These libraries are required for the Nsight Graphics GUI host to run. Refer to Qt Linux requirements for more information.

libxcb-cursor0
libxcb-icccm4-dev
libxcb-image0
libxcb-keysyms1
libxcb-render0
libxcb-render-util0
libxcb-shape0
libxcb-sync1
libxcb-util1
libxcb-xfixes0
libxcb-xinerama0
libxcb-xinput0
libxcb-xkb1
libxext6
libxkbcommon-x11-0
libxrender1