User Guide

  • 2021.4
  • 10/01/2021
  • Public Content

Command Line Options

Script name:
diagnostics.py
To run the Diagnostics Utility for Intel® oneAPI Toolkits, navigate to the directory where the it is installed and run
diagnostics.py
with one of the available arguments:
usage: diagnostics.py [--filter FILTER [FILTER ...]] [-l] [-c PATH_TO_CONFIG | -s PATH_TO_CHECKER] [-o PATH_TO_OUTPUT | -t] [-e PATH_TO_EXAMINE_RESULT] [-f] [-v] [-h] Diagnostics Utility for Intel® oneAPI Toolkits is a tool designed to diagnose the system status for using Intel® software. optional arguments: --filter FILTER [FILTER ...] Filter checker results by tag or checker name tags, combine one or more checkers into groups. Each checker can be marked with one or more tags. To view all available checkers with their names and marked tags, run the Diagnostics Utility for Intel® oneAPI Toolkits with the '--list' option. -l, --list Show list of available checks. -c PATH_TO_CONFIG, --config PATH_TO_CONFIG Path to the JSON config file to run a group of checks or particular check from checkers. -s PATH_TO_CHECKER, --single_checker PATH_TO_CHECKER Path to the checker module file which can be a library, python module, or executable bash. -o PATH_TO_OUTPUT, --output PATH_TO_OUTPUT Path to the folder for saving the console output file and the JSON file with the results of the performed checks. (default: $HOME/intel/diagnostics) -t, --terminal_output Allow output only to the terminal window without saving additional output files. -e PATH_TO_EXAMINE_RESULT, --examine PATH_TO_EXAMINE_RESULT Path to the JSON file containing the results of a previous launch of the Diagnostics Utility for Intel® oneAPI Toolkits to compare it with the current launch and highlight the differences in configurations. -f, --force Force the program to run on any operating system. -v, --verbosity Increase output verbosity. -h, --help Show this help message and exit. Diagnostics Utility for Intel® oneAPI Toolkits 2021.4.0 Copyright (C) Intel Corporation. All rights reserved.
To see examples of how the Diagnostic Utility arguments are used, see Using Checks to Diagnose Your System.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.