prepare release 1.9.6

ChangeLog

@@ -1,3 +1,9 @@
+2014-01-25  <rfranke>
+
+	* README.md, INSTALL.html, configure.in, configure:
+	  - release 1.9.6
+	  - add online docu in branch gh-pages
+
 2014-01-23  <rfranke>
 
 	* hxi/Hxi_SimStruct.[hC]:

INSTALL.html

@@ -72,33 +72,35 @@ <h3>Detailed installation steps</h3>
 
 <p><b>Feature options:</b></p>
 <dl>
- <dt>--enable-adolc</dt>
+ <dt><pre>--enable-adolc</pre></dt>
      <dd>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.</dd>
- <dt>--enable-fortran</dt>
+ <dt><pre>--enable-fortran</pre></dt>
      <dd>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.</dd>
- <dt>--enable-mex</dt>
-     <dd>Include MEX S-function interface with Omuses. This requires MATLAB(R)
-     and Simulink(R) on your machine for include files declaring data
+ <dt><pre>--enable-mex</pre></dt>
+     <dd>Include MEX S-function interface with Omuses. This requires MATLAB&reg;
+     and Simulink&reg; on your machine for include files declaring data
      structures and for runtime libs implementing mxArray.<br>
-     Additionally you may specify:<br>
-     --with-matlab<br>
-       Root directory of MATLAB(R) installation, e.g.
-       --with-matlab=/usr/local/matlab<br>
-     --with-matlab-libs<br>
-       Directory containing MATLAB(R) runtime libraries, e.g.
-       --with-matlab-libs=/usr/local/matlab/extern/lib/glnx86<br>
-    Note: see "Problems with MEX" below, if this feature does not work</dd>
- <dt>--enable-cute</dt>
+     Additionally you may specify:
+     <dl>
+     <dt><pre>--with-matlab</pre></dt>
+       <dd>Root directory of MATLAB&reg; installation, e.g.
+       <pre>--with-matlab=/usr/local/matlab</pre></dd>
+     <dt><pre>--with-matlab-libs</pre></dt>
+       <dd>Directory containing MATLAB&reg; runtime libraries, e.g.
+       <pre>--with-matlab-libs=/usr/local/matlab/extern/lib/glnx86</pre></dd>
+     </dl>
+    </dd>
+ <dt><pre>--enable-cute</pre></dt>
      <dd>Include CUTE interface with HQP.</dd>
- <dt>--enable-ascend</dt>
+ <dt><pre>--enable-ascend</pre></dt>
      <dd>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 @@ <h3>Detailed installation steps</h3>
 
 <p><b>Installation options:</b></p>
 <dl>
- <dt>--prefix=PATH</dt>
+ <dt><pre>--prefix=PATH</dt>
      <dd>Path where you'd like to install the libraries and include files
      (default is /usr/local).</dd>
 </dl>
 
 <p>Build options:</p>
 <dl>
- <dt>--disable-shared (--enable-shared)</dt>
+ <dt><pre>--disable-shared</pre> (<pre>--enable-shared</pre>)</dt>
      <dd>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.</dd>
- <dt>--enable-symbols</dt>
+ <dt><pre>--enable-symbols</pre></dt>
      <dd>build debug version, including symbolic information</dd>
- <dt>--enable-gmalloc</dt>
+ <dt><pre>--enable-gmalloc</pre></dt>
      <dd>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 @@ <h3>Detailed installation steps</h3>
 
 <p><b>Use a specific Tcl installation, which is not found automatically:</b></p>
 <dl>
- <dt>--with-tcl</dt>
+ <dt><pre>--with-tcl</pre></dt>
      <dd>Directory containing Tcl configuration file tclConfig.sh, e.g.
-     --with-tcl=/usr/local/lib</dd>
- <dt>--with-tclinclude</dt>
+     <pre>--with-tcl=/usr/local/lib</pre></dd>
+ <dt><pre>--with-tclinclude</pre></dt>
      <dd>Directory containing include file tcl.h.</dd>
 </dl>
 </li>
@@ -204,9 +206,17 @@ <h3>Using alternative compilers</h3>
 
 <h3>Hints for compiling under Windows</h3>
 
-<p>The POSIX/GNU build tools are still needed (tar, gzip, sh, make, patch). They are provided by <a href="http://www.mingw.org">MinGW</a> or <a href="http://www.cygwin.com">Cygwin</a>. These environments also include gcc and tcl, besides more.</p>
-
-<p>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).</p>
+<p>The POSIX/GNU build tools are still needed (tar, gzip, sh, make, patch).
+They are provided for Windows by <a href="http://www.mingw.org">MinGW</a> or
+<a href="http://www.cygwin.com">Cygwin</a>.
+These environments also include gcc and tcl, besides more.</p>
+
+<p>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 <code>--with-tcl</code> (see above).</p>
 
 */
 

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.

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)"

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