How do I use the Gurobi setup diagnostic tool? – Gurobi Help Center

Starting from v13, we have a new tool called grbdiagnose to diagnose issues with Gurobi setup issues.

It is included in both the Optimizer and the Remote Services package.

Steps:

Run grbdiagnose in either the client or the server.
- The tool automatically checks if the machine is the Compute Server client or the server.

grbdiagnose

Diagnostic tool started...
Log file: ./gurobi_diagnostics_20251003_195626.log has been generated in your current directory

Alternatively, the tool can be forced to assume the machine is a Compute Server client or server by using the flags client or server.

grbdiagnose --client

Diagnostic tool started...
Log file: ./gurobi_diagnostics_20251003_195750.log has been generated in your current directory

grbdiagnose --server

Diagnostic tool started...
Log file: ./gurobi_diagnostics_20251003_195803.log has been generated in your current directory

2. This will create a log file in the directory where it was executed. The log file will contain diagnostic information about the Gurobi setup to help troubleshoot issues.

3. The user can check the log file to see if a problem is easily identifiable. Otherwise, Gurobot can interpret the log file contents.

4. A Gurobi Expert can also use the log file contents to assist with troubleshooting issues more efficiently.

Notes:

The help flag can also be used to see additional information about the tool.

grbdiagnose --help

Usage:
  grbdiagnose --help         Display usage
  grbdiagnose [flags]        Diagnose and generate a log file of the findings

Flags can be set using --flag=value or the short form -f=value if defined.
A boolean flag can be enabled using --flag or the short form -f if defined.

Flags:
	
      --client         Force the diagnostic tool to assume the machine is the client
      --help           Display usage
      --logdirectory   Sets the directory where the log file will be saved
      --server         Force the diagnostic tool to assume the machine is the server
      --version        Display version information

Related articles