README.md

   1 [![Build Status](https://travis-ci.org/stevengj/nlopt.svg?branch=master)](https://travis-ci.org/stevengj/nlopt)
   2
   3 NLopt is a library for nonlinear local and global optimization, for
   4 functions with and without gradient information.  It is designed as
   5 as simple, unified interface and packaging of several free/open-source
   6 nonlinear optimization libraries.
   7
   8 The latest release and a complete manual may be found at the NLopt
   9 home page: http://ab-initio.mit.edu/nlopt
  10
  11 It is compiled and installed with CMake build system:
  12
  13     cmake .
  14     make install
  15
  16 See `./configure --help` or the `INSTALL` file for other options.  To
  17 build the latest development sources:
  18
  19     git clone git://github.com/stevengj/nlopt
  20     cd nlopt
  21     cmake .
  22     make
  23
  24 (To build from git, you will need SWIG.)
  25
  26 Once it is installed, `#include <nlopt.h>` in your C/C++ programs and
  27 link it with `-lnlopt -lm`.  You may need to use the C++ compiler to link
  28 in order to include the C++ libraries (which are used internally by NLopt,
  29 even though it has a C API).
  30
  31 The minimization function, `nlopt_minimize`, is described in the [man
  32 page](http://en.wikipedia.org/wiki/Man_page) (`api/nlopt_minimize.3`,
  33 which is installed by `make install`.  See also the manual on our
  34 web page.
  35
  36 There are also interfaces for Fortran, Python, Matlab, Octave, OCaml,
  37 GNU Guile, GNU R, Lua, and Julia.  Interfaces for other languages may
  38 be added in the future.