Provides a common interface to multiple optimizers.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
gurobi
metaopt
.gitignore
README.md
install-linux.sh
install-win.bat

README.md

Meta Optimizer

This library is designed to allow users to call out to third party optimization tools via a generic interface. This makes it easier for users to switch between optimizers in their client codewithout having to write problem definitions for each optimizer.

Supported Optimizers

Currently we support the following open source optimizers:

  • Apache
  • JOptimizer 3.5.1

... and the following commercial optimizers:

  • Gurobi 6

Install

First of all, make sure you have maven 3 and JDK 1.7+ installed and your PATH environment variable updated. Specifically, javac and mvn should be on your PATH, and M2_HOME and JAVA_HOME should be set to the respective installation directories.

Next, it is necessary to install the optimizers you wish to use. Apache and JOptimizer are readily available from maven central and should require no special steps to install, it should automatically be downloaded as part of the maven build cycle for metaopt. However, if you wish to install the other tools then there are some special steps that you should follow:

  • Gurobi - Gurobi is commerical software so you will need to follow their installation instructions and in particular, ensure that the GRB_LICENSE_FILE and GUROBI_HOME environment variables are setup correctly. Then you will need to install the gurobi.jar to your local maven repository. A script to do this is provided in the gurobi sub-directory.

Now that the optimizers are installed, you can install metaopt into your local maven repository by either typing in this directory "./install-linux.sh", or "./install-linux.sh --with-gurobi" if you wish to use gurobi. If using windows replace "...-linux.sh with -win.bat".

IMPORTANT NOTE: If you are using a Mac then please use the install-linux script rather than install-windows.

Usage

If using maven (which we strongly recommend), then you can simply add the following repository and dependency to your pom::

uk.ac.earlham.metaopt metaopt 1.0.0

Otherwise you will need to copy the metaopt jar file, along with all dependencies into your classpath.