Differences between revisions 7 and 188 (spanning 181 versions)
Revision 7 as of 2009-09-21 12:22:57
Size: 7274
Comment:
Revision 188 as of 2013-06-19 16:52:00
Size: 261
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:

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:
 * Linux (Debian or Ubuntu)
 * Windows 32-bit, using [[http://www.mingw.org|MinGW]]
 * Windows 32-bit, using [[http://www.cygwin.com|Cygwin]]

/!\ 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.

= General instructions =

== 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 [[http://gcc.gnu.org/|GNU Compiler Collection]] (GCC) (mandatory)
 * [[http://www.mathworks.com/products/matlab/|MATLAB]] (if you want to compile MEX for MATLAB)
 * [[http://www.octave.org|GNU Octave]], with the development headers (if you want to compile MEX for Octave)
 * [[http://www.boost.org|Boost libraries]], version 1.34 or later. Actually only the Graph library is needed. (mandatory)
 * [[http://www.gnu.org/software/bison/|Bison]], version 2.3 or later (only if you get the source through SVN)
 * [[http://flex.sourceforge.net/|Flex]], version 2.5.4 or later (only if you get the source through SVN)
 * [[http://www.gnu.org/software/autoconf/|Autoconf]], version 2.61 or later (only if you get the source through SVN)
 * [[http://www.gnu.org/software/automake/|Automake]] (only if you get the source through SVN)
 * [[http://www-cs-faculty.stanford.edu/~knuth/cweb.html|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 [[http://math-atlas.sourceforge.net/|ATLAS]], Netlib ([[http://www.netlib.org/blas/|BLAS]], [[http://www.netlib.org/lapack/|LAPACK]]) or [[http://software.intel.com/en-us/intel-mkl/|MKL]] (only if you want to build Dynare++)
 * An implementation of [[http://en.wikipedia.org/wiki/POSIX_Threads|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:
   * The Econometrica bibliography style: you need [[http://www.ctan.org/tex-archive/macros/latex/contrib/harvard/|harvard]] and [[http://www.ctan.org/tex-archive/biblio/bibtex/contrib/economic/|economic]] packages from CTAN (only if you want to build Dynare user guide)
   * [[http://www.tug.org/eplain/|Eplain]] TeX macros (only if you want to build Dynare++ source documentation)
   * [[http://latex-beamer.sourceforge.net/|Beamer]] (for some PDF presentations)
 * [[http://dblatex.sourceforge.net/|DBLaTeX]] (if you want to build Dynare reference manual in PDF)
 * [[http://xmlsoft.org/XSLT/xsltproc2.html|xsltproc]] and [[http://wiki.docbook.org/topic/DocBookXslStylesheets|DocBook XSL Stylesheets]] (if you want to build Dynare reference manual in HTML)
 * [[http://www.stack.nl/~dimitri/doxygen/|Doxygen]] (if you want to build Dynare preprocessor source documentation)

== 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).

== 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.

== 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
}}}

= 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}}}

= 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}}}

/!\ If you want to use the graphics capabilities of Octave, note that you must install an X11 server.
/!\ /!\ /!\ THIS PAGE IS OBSOLETE. The up-to-date instructions for building Dynare from the source code is contained in the [[https://github.com/DynareTeam/dynare/blob/master/README.md|README.md]] file in the Dynare root directory.

/!\ /!\ /!\ THIS PAGE IS OBSOLETE. The up-to-date instructions for building Dynare from the source code is contained in the README.md file in the Dynare root directory.

DynareWiki: BuildingDynareFromSource (last edited 2013-06-19 16:52:12 by HoutanBastani)