diff --git a/ChangeLog b/ChangeLog index ea87d74..38a087a 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2014-01-25 + + * README.md, INSTALL.html, configure.in, configure: + - release 1.9.6 + - add online docu in branch gh-pages + 2014-01-23 * hxi/Hxi_SimStruct.[hC]: diff --git a/INSTALL.html b/INSTALL.html index 636b355..98e2044 100644 --- a/INSTALL.html +++ b/INSTALL.html @@ -72,33 +72,35 @@

Detailed installation steps

Feature options:

-
--enable-adolc
+
--enable-adolc
Unpack and build the contained ADOL-C for automatic differentiation as part of Omuses. This simplifies the manual implementation of optimization programs. See the Odc demo collection, e.g. ./odc/Prg_BatchReactor.[hC] using ADOL-C vs. ./odc/Prg_BatchReactor_bare.[hC] accessing lower level interfaces.
-
--enable-fortran
+
--enable-fortran
Include the numerical integration routines RKsuite and optionally DASPK with libomu (see also daspk/README). This requires an f77 compiler on your machine. - Note: The automatic settings done by ./configure are only guesses. + Note: The automatic settings done by ./configure are for gfortran. Please check the variables FORTRAN_* in ./makedefs.
-
--enable-mex
-
Include MEX S-function interface with Omuses. This requires MATLAB(R) - and Simulink(R) on your machine for include files declaring data +
--enable-mex
+
Include MEX S-function interface with Omuses. This requires MATLAB® + and Simulink® on your machine for include files declaring data structures and for runtime libs implementing mxArray.
- Additionally you may specify:
- --with-matlab
- Root directory of MATLAB(R) installation, e.g. - --with-matlab=/usr/local/matlab
- --with-matlab-libs
- Directory containing MATLAB(R) runtime libraries, e.g. - --with-matlab-libs=/usr/local/matlab/extern/lib/glnx86
- Note: see "Problems with MEX" below, if this feature does not work
-
--enable-cute
+ Additionally you may specify: +
+
--with-matlab
+
Root directory of MATLAB® installation, e.g. +
--with-matlab=/usr/local/matlab
+
--with-matlab-libs
+
Directory containing MATLAB® runtime libraries, e.g. +
--with-matlab-libs=/usr/local/matlab/extern/lib/glnx86
+
+ +
--enable-cute
Include CUTE interface with HQP.
-
--enable-ascend
+
--enable-ascend
Include current preliminary version of an interface to Ascend4. This requires that this distribution is unpacked in the directory of the Ascend distribution, e.g. in /home/myname/ascendiv-0.9 @@ -107,20 +109,20 @@

Detailed installation steps

Installation options:

-
--prefix=PATH
+
--prefix=PATH
Path where you'd like to install the libraries and include files (default is /usr/local).

Build options:

-
--disable-shared (--enable-shared)
+
--disable-shared
(
--enable-shared
)
Build shared (static) libraries. Shared is default, except for Windows, where building a DLL is somewhat tricky. Shared libraries are required if Hqp/Omuses shall be used as package extending a Tcl application.
-
--enable-symbols
+
--enable-symbols
build debug version, including symbolic information
-
--enable-gmalloc
+
--enable-gmalloc
Use GNU malloc instead of the system routines. Gmalloc will be enabled automatically if your system malloc doesn't work properly (e.g. under DEC OSF). According to the authors experience gmalloc doesn't work on @@ -129,10 +131,10 @@

Detailed installation steps

Use a specific Tcl installation, which is not found automatically:

-
--with-tcl
+
--with-tcl
Directory containing Tcl configuration file tclConfig.sh, e.g. - --with-tcl=/usr/local/lib
-
--with-tclinclude
+
--with-tcl=/usr/local/lib
+
--with-tclinclude
Directory containing include file tcl.h.
@@ -204,9 +206,17 @@

Using alternative compilers

Hints for compiling under Windows

-

The POSIX/GNU build tools are still needed (tar, gzip, sh, make, patch). They are provided by MinGW or Cygwin. These environments also include gcc and tcl, besides more.

- -

Alternatively the native Windows compiler cl can be configured for the actual compilation (see above), provided it finds in the PATH environment -- the Visual Studio Command Prompt that comes with Visual Studio Tools sets the path. The POSIX shell for building HQP might be started from there. Tcl should be installed from a binary distribution available for Windows in this case and configured via --with-tcl (see above).

+

The POSIX/GNU build tools are still needed (tar, gzip, sh, make, patch). +They are provided for Windows by MinGW or +Cygwin. +These environments also include gcc and tcl, besides more.

+ +

Alternatively the native Windows compiler cl can be configured for the +actual compilation (CC=cl ./configure), provided it finds in the PATH +environment -- the Visual Studio Command Prompt that comes with +Visual Studio Tools sets the path; the POSIX shell for building HQP might be +started from there. Tcl should be installed from a binary distribution +available for Windows in this case and configured via --with-tcl (see above).

*/ diff --git a/README.md b/README.md index 004e07a..9e7d85b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # HQP: a solver for sparse nonlinear optimization -HQP is a solver for nonlinearly constrained large-scale optimization. It is intended for problems with sufficient regular sparsity structure. Such optimization problems arise e.g. from the numerical treatment of optimal control problems. +HQP is a numerical solver for nonlinearly constrained large-scale optimization. It is intended for optimization programs with sufficient regular sparse structure. Such programs arise e.g. from the numerical treatment of optimal control. -External interfaces allow the formulation of optimization problems based on widely used model formats. +External interfaces allow the formulation of optimization programs based on widely used formats, including also simulation formats. See also the [HQP Project Pages](http://omuses.github.io/hqp/) for an overview, literature references and online documentation. # License This software is free according to the conditions of the GNU LIBRARY GENERAL PUBLIC LICENSE, Version 2 (see COPYING.LIB). + +The distribution contains several other open source software packages that underly copyright and license conditions of their respective authors. The matrix library Meschach is required and has been further developed (see meschach/version.c). Other contained packages are optional and need to be enabled explicitly. diff --git a/configure b/configure index 1aedc50..241511f 100755 --- a/configure +++ b/configure @@ -2202,7 +2202,7 @@ ac_compiler_gnu=$ac_cv_c_compiler_gnu MAJOR_VERSION=1 MINOR_VERSION=9 PATCHLEVEL_BASE=6 -DEVELOPMENT_VERSION=yes +DEVELOPMENT_VERSION=no # note: PATCHLEVEL is formed by appending to PATCHLEVEL_BASE the # modification date of ChangeLog if DEVELOPMENT_VERSION = yes @@ -4903,7 +4903,7 @@ if test "$omu_adolc" = yes; then tar xzf adolc-1.9.0-PL2.tar.gz; mv adolc-1.9.0 adol-c; patch -p0 -N -s < hqp_adolc.patch; - # Note: ADOL-C 1.9.0 configures PICFLAG wrong und Linux and MinGW with gcc 4.8 + # Note: ADOL-C 1.9.0 configures PICFLAG wrong under Linux and MinGW (gcc 4.8) cd adol-c; ./configure --with-cflags="$CFLAGS" --with-cxxflags="$CXXFLAGS"; cd ..; cd .. ASRCS="\$(ASRCS)" diff --git a/configure.in b/configure.in index d2caa80..45864c2 100644 --- a/configure.in +++ b/configure.in @@ -6,7 +6,7 @@ AC_INIT(hqp/Hqp.h) MAJOR_VERSION=1 MINOR_VERSION=9 PATCHLEVEL_BASE=6 -DEVELOPMENT_VERSION=yes +DEVELOPMENT_VERSION=no # note: PATCHLEVEL is formed by appending to PATCHLEVEL_BASE the # modification date of ChangeLog if DEVELOPMENT_VERSION = yes