README.md

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