Skip to content

Commit

Permalink
Highlight unofficial nature of wrapper in readme (#202)
Browse files Browse the repository at this point in the history
* Highlight unofficial nature of wrapper in readme

* Update README.md
  • Loading branch information
odow authored Nov 19, 2018
1 parent b4673f1 commit 97305ae
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
CPLEX.jl
========

The CPLEX.jl package provides an unofficial interface for using [IBM® ILOG® CPLEX® Optimization Studio](https://www.ibm.com/products/ilog-cplex-optimization-studio) from the [Julia language](http://julialang.org/). You cannot use CPLEX.jl without having purchased and installed a copy of CPLEX Optimization Studio from [IBM](http://www.ibm.com/). This package is available free of charge and in no way replaces or alters any functionality of IBM's CPLEX Optimization Studio product.

CPLEX.jl is a Julia interface for the CPLEX optimization software. CPLEX functionality is extensive, so coverage is incomplete, but the basic functionality for solving linear and mixed-integer programs is provided.

CPLEX.jl is intended for use with the [MathProgBase](https://github.com/JuliaOpt/MathProgBase.jl) solver interface; an internal API, while present, is not documented.
CPLEX.jl is an unofficial interface to the [IBM® ILOG® CPLEX® Optimization
Studio](https://www.ibm.com/products/ilog-cplex-optimization-studio). It
provides an interface to the low-level C API, as well as an implementation of
the solver-independent [`MathProgBase`](https://github.com/JuliaOpt/MathProgBase.jl)
and [`MathOptInterface`](https://github.com/JuliaOpt/MathOptInterface.jl) API's.

You cannot use CPLEX.jl without having purchased and installed a copy of CPLEX
Optimization Studio from [IBM](http://www.ibm.com/). This package is available
free of charge and in no way replaces or alters any functionality of IBM's CPLEX
Optimization Studio product.

*Note: This wrapper is maintained by the JuliaOpt community and is not
officially supported by IBM. If you are a commercial customer interested in
official support for CPLEX in Julia, let them know!.*

Setting up CPLEX on OS X and Linux
----------------------------------
Expand Down

0 comments on commit 97305ae

Please sign in to comment.