Documentation


File Overview

This section briefly describes the purposes of the more important files in the Gurobi distribution. Note that the list below may not precisely agree with your installation. We've omitted a few less important files. In addition, a few file names depend on the exact version of the Gurobi optimizer that you installed.

The following files and directories are created in your installation directory (typically /Library/gurobi811/mac64 for the Mac distribution):

  • EULA.pdf - Gurobi End User License Agreement - PDF format
  • ReleaseNotes.html - release notes
  • bin
    • grbcluster - Cluster manager command-line
    • grb_ts - Gurobi Token Server executable
    • grbgetkey - retrieves your Gurobi license key from the Gurobi key server
    • grbprobe - probes system details (typically not used)
    • grbtune - parameter tuning tool
    • gurobi_cl - simple command-line binary
    • gurobi.env - sample parameter initialization file
    • gurobi.sh - starts the Gurobi interactive shell
  • docs
    • examples - Example Tour - HTML (open index.html in this directory)
    • examples.pdf - Example Tour - PDF
    • quickstart - Quick Start guide - HTML (open index.html in this directory)
    • quickstart_mac.pdf - Quick Start guide - PDF
    • refman - Reference Manual - HTML (open index.html in this directory)
    • refman.pdf - Reference Manual - PDF
    • remoteservices - Remote Services Reference Manual - HTML (open index.html in this directory)
    • remoteservices.pdf - Remote Services Reference Manual - PDF
  • examples
    • build - Makefile for C, C++, C#, Java, and Python examples
    • c - source code for C examples
    • c# - source code for C# examples
    • c++ - source code for C++ examples
    • data - data files for examples
    • dotnetcore - Makefile and .NET Core App files for C# examples
    • java - source code for Java examples
    • matlab - source code for MATLAB examples
    • python - source code for Python examples
    • R - source code for R examples
    • vb - source code for Visual Basic examples (for Windows)
  • include
    • gurobi_c.h - C include file
    • gurobi_c++.h - C++ include file
  • lib
    • gurobi.jar - Java interface
    • gurobi-javadoc.jar - Javadoc documentation for our Java interface
    • gurobi81.netstandard20.dll - .NET Standard 2.0 interface
    • gurobi81.netstandard20.xml - .NET Standard 2.0 interface documentation
    • gurobi.py - Python startup file
    • gurobipy - Python files used by the interactive shell and the Python interface (no need to look inside this directory)
    • libGurobiJni81.jnilib - Java JNI wrapper
    • libgurobi81.so - Gurobi native library (used by all interfaces)
    • libgurobi81_light.so - light Gurobi native library (no support for Compute Server or Instant Cloud)
    • libgurobi_c++.a - C++ interface (symbolic link)
    • libgurobi_g++4.2.a - C++ interface
  • matlab - Gurobi MATLAB interface
  • R - R Gurobi package
  • setup.py - Python setup file - used by the installer to install the gurobipy module into your Python environment
  • src
    • build - Makefile for Gurobi C++ interface
    • cpp - Source for Gurobi C++ interface

The following files and directories are created in your Remote Services installation (typically /Library/gurobi_server811/mac64 for the Mac distribution):

  • EULA.pdf - Gurobi End User License Agreement - PDF format
  • ReleaseNotes.html - release notes
  • bin
    • grbcluster - Cluster manager command-line
    • grb_rs - Gurobi Remote Services executable
    • grb_rs.cnf - Default configuration file for the Remote Services
    • grb_rs_aws.cnf - Example configuration file for the Remote Services deployment with AWS
    • grb_rsr - Gurobi Remote Services Router executable
    • grb_rsr.cnf - Default configuration file for the Remote Services Router
    • grb_ts - Gurobi Token Server executable
    • grbgetkey - retrieves your Gurobi license key from the Gurobi key server
    • grbprobe - probes system details (typically not used)
    • data
      • files - Temporary data files for job execution
      • runtimes - Worker execuatbles for supported versions
  • docs
    • remoteservices - Remote Services Reference Manual - HTML (open index.html in this directory)
    • remoteservices.pdf - Remote Services Reference Manual - PDF
  • resources - Internal resource files for web UI