Documentation

Retrieving a Free Academic license


Retrieving a Free Academic license

To obtain a Gurobi license key you'll need to run the grbgetkey command on your machine to retrieve your Gurobi license key. Note that the machine must be connected to the Internet in order to run this command. An Internet connection is not required after you have obtained your license key.

The exact command to run for a specific license is indicated at the bottom of the License Detail page (e.g., grbgetkey 253e22f3-...). We recommend that you use copy-paste to copy the entire grbgetkey command from our website and paste it directly into the Windows Search box (and then hit Enter):

Image startrun
If you are unfamiliar with running command-line commands on a Windows system, you can learn more here.

The grbgetkey program passes identifying information about your machine back to our website, and the website responds with your license key. Once this exchange has occurred, grbgetkey will ask for the name of the directory in which to store your license key file (gurobi.lic). You should see a prompt that looks like this:

Gurobi license key client (version 8.1.1)
Copyright (c) 2019, Gurobi Optimization, LLC

-------------------------------
Contacting Gurobi key server...
-------------------------------

Key for license ID 146542 was successfully retrieved.

---------------------
Saving license key...
---------------------

In which folder would you like to store the Gurobi license key file?
[hit Enter to store it in c:\gurobi]:

-> License key saved to file 'c:\gurobi\gurobi.lic'.

You can store the license key file anywhere, but we strongly recommend that you accept the default location (either your home directory or c:\gurobi) by hitting Enter. Setting up a non-default location is error-prone and a frequent source of trouble.

If you receive an error message at this stage, it typically means that we were unable to validate your academic domain. Please consult the Academic Validation section for more information.

Using a non-default license file location

When you run the Windows version of the Gurobi Optimizer, it will look for the gurobi.lic key file in two different default locations: c:\gurobi and c:\gurobi811 (for Gurobi 8.1.1). Note that these default paths are absolute, so for example Gurobi will look for the license key file in c:\gurobi, even if the software is installed in d:\gurobi. Note that the token server won't look for the license file in your home directory (it runs under username LocalService, so it doesn't have access to your home directory). If you would like to use a non-default license key file location, you can do so by setting a system environment variable GRB_LICENSE_FILE to point to the license key file. See Setting environment variables for details on how to do this.

Important note: the environment variable should point to the license key file itself, not to the directory that contains the file.

Next steps

If your license includes the Distributed Add-On and you plan to use any of the Gurobi distributed algorithms, you'll also need to set up Gurobi Remote Services on your distributed worker machines.

Once you have followed the steps above and have obtained a license key file, your next step is to test your license.



Subsections