Differences between revisions 2 and 3
Revision 2 as of 2009-09-18 16:40:23
Size: 3492
Comment:
Revision 3 as of 2009-09-18 17:01:52
Size: 5833
Comment:
Deletions are marked like this. Additions are marked like this.
Line 8: Line 8:
 * or using a snapshot or (when Dynare 4.1 is released) a source archive, from the website  * or using a snapshot or (when Dynare 4.1 is released) an official source archive, from the website
Line 13: Line 13:
 * Linux  * Linux (Debian or Ubuntu)
Line 27: Line 27:
 * A POSIX compliant shell and an implementation of Make (mandatory)
 * The [[http://gcc.gnu.org/|GNU Compiler Collection]] (GCC) (mandatory)
Line 29: Line 31:
 * [[http://www.boost.org|Boost libraries]], version 1.34 or later (mandatory)  * [[http://www.boost.org|Boost libraries]], version 1.34 or later. Actually only the Graph library is needed. (mandatory)
Line 40: Line 42:
   * [[http://latex-beamer.sourceforge.net/|Beamer]] (for some PDF presentations)
Line 43: Line 46:

== Preparing the sources ==

If you have downloaded the sources from an official source archive or the snapshot, just unpack it.

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}}}
 * {{{texlive-extra-utils}}}
 * {{{texlive-formats-extra}}}
 * {{{latex-beamer}}}
 * {{{dblatex}}}
 * {{{xsltproc}}}
 * {{{docbook-xsl}}}
 * {{{doxygen}}}

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:

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, using MinGW

  • Windows, using Cygwin

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 quiclky 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 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:
    • The Econometrica bibliography style: you need harvard and economic packages from CTAN (only if you want to build Dynare user guide)

    • Eplain TeX macros (only if you want to build Dynare++ source documentation)

    • Beamer (for some PDF presentations)

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

Preparing the sources

If you have downloaded the sources from an official source archive or the snapshot, just unpack it.

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

  • texlive-extra-utils

  • texlive-formats-extra

  • latex-beamer

  • dblatex

  • xsltproc

  • docbook-xsl

  • doxygen

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