View source for Building ASCEND for 64-bit Windows

We now have a working version of ASCEND on 64-bit Windows. Before you can use these instructions, you need to carefully follow the rather long list of instructions for [[setting up a MinGW-w64 build environment]]. If you're interested in building ASCEND for other platforms, see [[building ASCEND]].

== Compile-time prerequisites ==

=== CUnit testing library ===

Note the directions for building and installing CUnit as per [[Developer's Manual#CUnit test suites]]. For MinGW-w64 use the following steps:
 
 cd ~
 svn co svn://svn.code.sf.net/p/cunit/code/branches/mingw64 cunit
 cd cunit
 ./configure --prefix=/mingw --enable-examples --enable-debug
 make
 make install

The CUnit test suites seem to be basically working. We have made changes to CUnit and currently require that you access the svn branch 'mingw64' version of CUnit for ASCEND testing. A new CUnit release is planned. 

Currently, failing test cases on MinGW-w64 are:
** compiler_autodiff (issue with a non-null pointer in line 198)
** compiler_bintok (program hangs! possibly just a configuration issue? looks like the parser is waiting for input from stdin)
** compiler_blackbox (lacking error code in return from parse. not Win64 specific)

You may be able to check the current build status on our [http://build.ascend4.org buildbot].

=== SUNDIALS ===

SUNDIALS is used by the [[IDA]] solver in ASCEND. First download and save sundials-2.4.0 from  the [http://computation.llnl.gov/casc/sundials/download/download.html SUNDIALS download page]. Unpack, build and install as follows:

 tar zxf /c/Users/'''yourusername'''/Downloads/sundial-2.4.0.tar.gz
 cd sundials-2.4.0
 ./configure --build=x86_64-w64-mingw32 --prefix=/mingw F77=gfortran
 make
 make install

SUNDIALS at v2.4.0 doesn't support <tt>DESTDIR=~/temp-install</tt> in the <tt>make install</tt> step, which is annoying becuase it's not quite as easy to 'catch' the installed files and distribute a binary.

Note, for 32-bit, use <tt>./configure --prefix=/mingw F77=gfortran</tt> above. We need to test again whether the <tt>--build=x86_64-w64-mingw32</tt> part is needed for 64-bit builds, or not.

=== IPOPT ===

[[IPOPT]] is a free open-source optimisation solver which can be accessed from ASCEND.

* Download and unpack [http://www.coin-or.org/download/source/Ipopt/Ipopt-3.11.3.tgz Ipopt-3.11.3.tgz]:
 cd ~
 wget http://www.coin-or.org/download/source/Ipopt/Ipopt-3.11.3.tgz 
 tar zxf Ipopt-3.11.3.tgz
 cd Ipopt-3.11.3
* Download the third-party dependencies
 cd ThirdParty/Blas && ./get.Blas
 cd ../Metis && ./get.Metis
 cd ../Mumps && ./get.Mumps
 cd ../Lapack && ./get.Lapack
* Configure and build IPOPT (configuration takes a several minutes, building takes ~15 min or so):
 cd ~/Ipopt-3.11.3
 ./configure --enable-static=yes --enable-shared=no --prefix=/mingw ADD_FFLAGS="-fopenmp -static-libgcc" --disable-pthread-mumps
 make
 make install
 make test

Note: above <tt>./configure</tt> command is a special workaround for 64-bit Windows. Thanks for Stefan Vigerske and Tony Kelman for their help with these instructions (and for [http://www.mpclab.net/Trac/wiki/CompilingIpopt#MinGW this page]), and for the suggested changes to our [[Setting up a MinGW-w64 build environment|MinGW-w64 set-up guidelines]]. See also [https://projects.coin-or.org/Ipopt/ticket/215 IPOPT bug 215]. It is probable that on 32-bit, a simpler command without the 'ADD_FFLAGS' will work OK, but it may change the resulting DLL dependencies of the final DLL/executables.

If the install works OK you should have some /mingw/libcoin* and /mingw/libipopt.a files.

This will build you a static IPOPT solver. There isn't a way to build a DLL of IPOPT with MinGW yet, apparently (although the static libary for IPOPT can be incorporated into a DLL as we have done for our [[IPOPT]] external solver in ASCEND).

Currently the resulting IPOPT depends on libgfortran and libstdc++. If you build the resulting static libraries into a DLL or an EXE, that DLL/EXE will have shared library dependencies on the ligfortran and libstdc++ DLLs that come with MinGW/MinGW-w64. We would rather like to have the code from of those external DLLs statically linked, but don't yet know how that's possible.

== Building ASCEND ==

If your [[Setting up a MinGW-w64 build environment|Windows build environment]] is set up correctly, and you have a current copy of the source code (either from [[VersionManagement|our subversion repository]] or a source-code tarball), you should be able to simply run:

 scons -j4

If your environment is set up correctly, your build should complete correctly on both 64-bit and 32-bit build environments.

To run test suites, try

 scons test ascend solvers models
 test/test_expectpass

This script should run all the test cases currently expected to pass. You can also try

 scons test ascend solvers models MALLOC_DEBUG=1
 test/test_expectpass_mallocdebug

to test those functions which require malloc debugging to also be tested.  This latter set of tests removes some other ones because of known memory leakage.

== Runtime prerequisites ==

To actually run the GUI resulting from the above build, you still need to install GTK+, PyGTK, PyCairo, PyGObject. Get the amd64 py2.7 packages from this page:

* Install GTK+2 as detailed in [[setting up a MinGW-w64 build environment]].
* From the [http://sourceforge.net/projects/ascend-sim/files/thirdparty/ ASCEND third-party download page], download and install:
** [http://sourceforge.net/projects/ascend-sim/files/thirdparty/pygtk-2.22.0.win-amd64-py2.7.exe/download pygtk-2.22.0.win-amd64-py2.7.exe]
** [http://sourceforge.net/projects/ascend-sim/files/thirdparty/pygobject-2.28.6.win-amd64-py2.7.exe/download pygobject-2.28.6.win-amd64-py2.7.exe]
** [http://sourceforge.net/projects/ascend-sim/files/thirdparty/py2cairo-1.10.0.win-amd64-py2.7.exe/download py2cairo-1.10.0.win-amd64-py2.7.exe]
* In order to have plotting and console support in the PyGTK GUI, Download and install the following Python packages from http://www.lfd.uci.edu/~gohlke/pythonlibs (sorry, this website doesn't allow direct URL links). Be sure to use the'''win-amd64-py2.7''' versions for 64-bit Python, or the '''win32-py2.7''' files for 32-bit Python:
** six (required for dateutil)
** pyparsing (required for matplotlib)
** dateutil (required for matplotlib)
** numpy-MKL (required for matplotlib)
** matplotlib (optional)
** setuptools (required for ipython)
** pyreadline (required for ipython)
** ipython (optional)

To test the above:
* You should be able to start IPython (pylab mode) from the Start menu, without any errors output
* c:\Program Files\GTK+-2.22\bin\gtk-demo.exe should run from the windows command prompt, and pop up a window with some GUI demos
* After setting your PATH to include <tt>c:\Program Files\GTK+-2.22\bin</tt> (and possibly log out and log in again) you should be able to start Python and try:
<source lang=py>import gtk
w = gtk.Window()
w.add(gtk.Label("hello"))
w.show_all()
</source>

Some helpful diagnostics for finding out why 'import gtk' gives errors in some cases: (in my case, I needed to add c:/GTK/bin to the START of my PATH because of a conflicting ZLIB1.DLL earlier in my PATH.
* http://gramps-project.org/wiki/index.php?title=ImportError:_DLL_load_failed

== Building the ASCEND installer ==

If you have NSIS installed on your system then you will be able to build working installer for ASCEND. It's a 32-bit installer that installs a 64-bit ASCEND library/executable/etc.

Before you can build the installer, you need to download the NSIS [http://nsis.sourceforge.net/Inetc_plug-in Inetc plugin], and extract the inetc.dll file into your <tt>c:\Program Files (x86)\NSIS</tt> plugins folder.

Some issues to address/check:
* make sure no WoW3264Node confusions arise when trying to install 64-bit ASCEND on 64-bit Windows.
* possible issue with IPOPT with 32-bit installer used on 64-bit Windows. Also check IPOPT with 64-bit version.
* how to make sure that installed versions of GTK/Python etc are 64 bit and not 32-bit?
* are there any issues with MSVCR90.DLL not being present? PyGTK seems to depend on it.
* what happens when you try to install on Windows 32? does it fail gracefully?
* consider including all required dependencies in the package: total size would be +~45MB (minus compression savings, minus optimisations from removing unneeded bits of GTK+?)

[[Category:Development]]