This page explains how to build from source:
- Dynare (unstable version), including preprocessor and MEX files for MATLAB and Octave
- Dynare++
- all the associated documentation (PDF and HTML) from source
This source can be retrieved in two forms:
with subversion (SVN), at https://www.dynare.org/svn/dynare/trunk
- or using a snapshot or (when Dynare 4.1 is released) an official source archive, from the website
Note that if you use the SVN version, you will need to install more tools (see below).
The first section of this page gives general instructions, which apply to all platforms. Then some specific platforms are discussed:
Here, when we refer to 32-bit or 64-bit, we refer to the type of MATLAB installation, not the type of Windows installation. It is perfectly possible to run a 32-bit MATLAB on a 64-bit Windows: in that case, instructions for Windows 32-bit should be followed. To determine the type of your MATLAB installation, type:
>> computer
at the MATLAB prompt: if it returns PCWIN, then you have a 32-bit MATLAB; if it returns PCWIN64, then you have a 64-bit MATLAB.
For Windows users, there is no pareto-optimum between MinGW and Cygwin, it depends on what you want to do:
- MinGW is simpler to setup if you just want to quickly compile the binaries,
- Cygwin is recommended for those who update through SVN, or who want to build documentation.
1. General instructions
1.1. Prerequisites
A number of tools and libraries are needed in order to recompile everything. You don't necessarily need to install everything, depending on what you want to compile.
- A POSIX compliant shell and an implementation of Make (mandatory)
The GNU Compiler Collection (GCC) (mandatory)
MATLAB (if you want to compile MEX for MATLAB)
GNU Octave, with the development headers (if you want to compile MEX for Octave)
Boost libraries, version 1.34 or later. Actually only the Graph library is needed. (mandatory)
Bison, version 2.3 or later (only if you get the source through SVN)
Flex, version 2.5.4 or later (only if you get the source through SVN)
Autoconf, version 2.61 or later (only if you get the source through SVN)
Automake (only if you get the source through SVN)
CWEB, with its tools ctangle and cweave (only if you want to build Dynare++ and get the source through SVN)
An implementation of BLAS and LAPACK: either ATLAS, Netlib (BLAS, LAPACK) or MKL (only if you want to build Dynare++)
An implementation of POSIX Threads (only if you want to build Dynare++)
- A decent LaTeX distribution (if you want to compile PDF documentation). The following extra components may be needed:
DBLaTeX (if you want to build Dynare reference manual in PDF)
xsltproc and DocBook XSL Stylesheets (if you want to build Dynare reference manual in HTML)
Doxygen (if you want to build Dynare preprocessor source documentation)
1.2. Preparing the sources
If you have downloaded the sources from an official source archive or the snapshot, just unpack it.
If you are using the snapshot, since it contains a build tree for Windows, you first need to clean it with:
make clean
If you want to use SVN, do the following from a terminal:
svn checkout https://www.dynare.org/svn/dynare/trunk dynare cd dynare autoreconf -s -i
The last line runs Autoconf and Automake in order to prepare the build environment (this is not necessary if you got the sources from an official source archive or the snapshot).
1.3. Configuring the build tree
You just launch the configure script from a terminal:
./configure
If you have MATLAB, you need to indicate both MATLAB location and MATLAB version. For example, on Linux:
./configure --with-matlab=/usr/local/matlab78 MATLAB_VERSION=7.8
Note that MATLAB version can also specified via the MATLAB family product release (R2009a, R2008b, ...).
You may need to specify additional options to the configure script, see the platform specific instructions below.
If the configuration goes well, the script will tell you which components are correctly configured and will be built.
1.4. Building
Binaries are built with:
make
PDF and HTML documentation are respectively built with:
make pdf make html
The testsuites can be run with:
make check
2. Debian or Ubuntu
All the prerequisites are packaged. If you want to build everything, install the following packages:
build-essential (for gcc, g++ and make)
octave3.2-headers or octave3.0-headers (will install ATLAS)
libboost-graph1.40-dev, libboost-graph1.39-dev, libboost-graph1.38-dev, libboost-graph1.37-dev, libboost-graph1.35-dev or libboost-graph-dev
flex
bison
autoconf
automake
texlive
texlive-publishers (for Econometrica bibliographic style)
texlive-extra-utils (for CWEB)
texlive-formats-extra (for Eplain)
latex-beamer
dblatex
xsltproc
docbook-xsl
doxygen
3. Windows 32-bit, using Cygwin
First, you need to setup a Cygwin environment, following the instructions at http://www.cygwin.com.
Then, install the following packages:
make
gcc, gcc-g++ and gcc-g77
gcc-mingw, gcc-mingw-g++ and gcc-mingw-g77
bison
flex
autoconf and autoconf2.5
automake and automake1.11
octave and octave-devel (will install BLAS and LAPACK)
tetex and tetex-extra
libxslt (for xsltproc)
docbook-xsl
doxygen
subversion (only if you retrieve Dynare sources through SVN)
If you want to use the graphics capabilities of Octave, note that you must also install an X11 server.
The version of Boost included with Cygwin is too old. You need to download a more recent version (1.40 at the time of this writing), on http://www.boost.org.
Then uncompress the Boost sources somewhere, let's say in /home/user:
tar xvjf boost_1_40_0.tar.bz2
Note that you don't need to compile any Boost libraries; Dynare only make use of the headers.
Also note that dblatex, Econometrica biliographic style and eplain are not packaged in Cygwin: you need to install them manually if you want to build the corresponding documentation.
Then, assuming that you are in the Dynare source tree, configure the package.
If you don't have MATLAB, do:
./configure CPPFLAGS="-I/home/user/boost_1_40_0"
If you have MATLAB, let's say version R2009a installed in c:/Program Files/MATLAB/R2009a, do:
./configure --with-matlab=/cygdrive/c/Progra~1/MATLAB/R2009 MATLAB_VERSION=R2009a CPPFLAGS="-I/home/user/boost_1_40_0"
Note that here we use Progra~1 (the 8.3 filename) instead of Program Files. This is because spaces in filenames confuse the configuration scripts.
Then compile everything with:
make make pdf make html
This should build:
- Dynare preprocessor
- Dynare MEX files for Octave (for use with the Octave version bundled with Cygwin)
- Dynare MEX files for MATLAB (provided you gave the MATLAB path to configure)
- Dynare++
- Part of the documentation
In order to be able to run Dynare from MATLAB, you need to tell MATLAB where to find the Cygwin DLL. More precisely, you need to add c:\cygwin\bin to your execution path, otherwise Dynare will fail to run the preprocessor. There are two ways of doing it:
- Locally from MATLAB, only for one session, by typing the following at MATLAB prompt:
>> setenv('PATH', [ getenv('PATH') ';c:\cygwin\bin' ])
Globally and once, by changing the global Windows settings. Go to the configuration panel, then in "System", then in "Advanced settings" tab, then "Environment Variables", and modify the variable PATH by adding ;c:\cygwin\bin at the end of it (the semicolon is the separator)