2015-09-01 15:00:07 +02:00
< a name = "logo" / >
2015-07-21 18:29:08 +02:00
< div align = "center" >
2019-04-16 15:00:24 +02:00
< a href = "https://www.dynare.org/" target = "_blank" >
< img src = "https://www.dynare.org/assets/images/logo/dlogo.svg" alt = "Dynare Logo" > < / img >
2015-07-21 18:29:08 +02:00
< / a >
< / div >
2013-06-19 17:50:36 +02:00
# Dynare
2019-04-16 15:00:24 +02:00
Described on the homepage: < https: / / www . dynare . org / >
2013-06-19 17:50:36 +02:00
2019-05-22 14:27:34 +02:00
Most users should use the precompiled package available for their OS, also
2019-04-16 15:00:24 +02:00
available via the Dynare homepage: < https: / / www . dynare . org / download / > .
2013-06-19 17:50:36 +02:00
2015-12-08 13:43:42 +01:00
# Contributions
2018-09-10 11:55:04 +02:00
To contribute to Dynare and participate in the Dynare community, please see: [CONTRIBUTING.md ](https://git.dynare.org/Dynare/dynare/blob/master/CONTRIBUTING.md )
2015-12-08 13:43:42 +01:00
2013-06-19 17:50:36 +02:00
# License
Most of the source files are covered by the GNU General Public Licence version
3 or later (there are some exceptions to this, see [license.txt ](license.txt ) in
Dynare distribution for specifics).
# Building Dynare From Source
Here, we explain how to build from source:
- Dynare, including preprocessor and MEX files for MATLAB and Octave
- all the associated documentation (PDF and HTML)
This source can be retrieved in three forms:
2018-09-10 11:55:04 +02:00
- via git, at < https: // git . dynare . org / Dynare / dynare . git >
2019-04-16 15:00:24 +02:00
- using the stable source archive of the latest Dynare version from < https: // www . dynare . org / download />
- using a source snapshot of the unstable version, also from < https: // www . dynare . org / download />
2013-06-19 17:50:36 +02:00
Note that if you obtain the source code via git, 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.
2019-05-22 14:27:34 +02:00
**Note:** Here, when we refer to 32-bit or 64-bit, we refer to the type of
MATLAB or Octave installation, not the type of operating system installation.
For example, 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/Octave installation, type:
2013-06-19 17:50:36 +02:00
```matlab
>> computer
```
2023-04-25 23:51:42 +02:00
at the MATLAB/Octave prompt. Under MATLAB, if it returns `PCWIN64` , `GLNX64` ,
`MACI64` or `MACA64` then it is a 64-bit MATLAB; if it returns `PCWIN` , `MACI` or `GLNX` ,
2019-05-22 14:27:34 +02:00
then it is a 32-bit MATLAB. Under Octave, if it returns a string that begins
with `x86_64` , it is a 64-bit Octave; if the strings begins with `i686` , it is
a 32-bit Octave.
2013-06-19 17:50:36 +02:00
**Contents**
1. [**General Instructions** ](#general-instructions )
1. [**Debian or Ubuntu** ](#debian-or-ubuntu )
2020-11-10 15:41:27 +01:00
1. [**Fedora, CentOS or RHEL** ](#fedora-centos-or-rhel )
2013-06-19 17:50:36 +02:00
1. [**Windows** ](#windows )
2018-02-13 16:38:50 +01:00
1. [**macOS** ](#macos )
2023-07-09 11:09:36 +02:00
1. [**Docker** ](#docker )
2013-06-19 17:50:36 +02:00
## 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)
2022-05-05 17:09:58 +02:00
- The [GNU Compiler Collection ](https://gcc.gnu.org/ ), version 10 or later, with
2019-02-01 12:27:15 +01:00
gcc, g++ and gfortran (mandatory)
2020-11-06 16:28:18 +01:00
- [MATLAB ](https://mathworks.com ) (if you want to compile the MEX for MATLAB)
2022-05-05 17:09:58 +02:00
- [GNU Octave ](https://www.octave.org ) with
2020-11-06 16:28:18 +01:00
- the development headers (if you want to compile the MEX for Octave)
- the development libraries corresponding to the [UMFPACK ](https://people.engr.tamu.edu/davis/suitesparse.html ) packaged with Octave
2022-05-05 17:09:58 +02:00
- Optionally, the [Control ](https://octave.sourceforge.io/control/ ), [IO ](https://octave.sourceforge.io/io/ ), [Optimization ](https://octave.sourceforge.io/optim/ ) and [Statistics ](https://octave.sourceforge.io/statistics/ ) package either installed via your package manager or through [Octave Forge ](https://octave.sourceforge.io/ ).
- [Boost libraries ](https://www.boost.org ), version 1.36 or later
- [Bison ](https://www.gnu.org/software/bison/ ), version 3.2 or later (only if you get the source through Git)
- [Flex ](https://github.com/westes/flex ), version 2.5.4 or later (only if you get the source through Git)
- [Autoconf ](https://www.gnu.org/software/autoconf/ ), version 2.62 or later (only if you get the source through Git)
- [Automake ](https://www.gnu.org/software/automake/ ), version 1.11.2 or later (only if you get the source through Git)
2023-04-17 17:19:43 +02:00
- [MAT File I/O library ](https://sourceforge.net/projects/matio/ ), version 1.5 or later (if you want to compile Markov-Switching SBVAR code)
2013-06-19 17:50:36 +02:00
- [SLICOT ](http://www.slicot.org ) (if you want to compile the Kalman steady state DLL)
2023-04-17 17:19:43 +02:00
- [GSL library ](https://www.gnu.org/software/gsl/ ) (if you want to compile Markov-Switching SBVAR code)
2019-01-08 16:12:02 +01:00
- A decent LaTeX distribution (if you want to compile PDF documentation),
ideally with Beamer
2013-06-19 17:50:36 +02:00
- For building the reference manual:
2022-05-05 17:09:58 +02:00
- [Sphinx ](https://www.sphinx-doc.org/ )
2019-02-21 16:58:18 +01:00
- [MathJax ](https://www.mathjax.org/ )
2022-05-05 17:09:58 +02:00
- [Doxygen ](https://www.doxygen.nl ) (if you want to build Dynare preprocessor source documentation)
- [X-13ARIMA-SEATS Seasonal Adjustment Program ](https://www.census.gov/data/software/x13as.html )
2013-06-19 17:50:36 +02:00
### Preparing the sources
If you have downloaded the sources from an official source archive or the source snapshot, just unpack it.
2022-05-20 12:43:04 +02:00
If you want to use Git, do the following from a terminal (note that you must
have the [Git LFS ](https://git-lfs.github.com/ ) extension installed):
2020-11-06 16:28:18 +01:00
```sh
git clone --recurse-submodules https://git.dynare.org/Dynare/dynare.git
cd dynare
autoreconf -si
```
2022-05-20 12:39:59 +02:00
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 source snapshot). If you want a certain version (e.g. 5.x) , then add `--single-branch --branch 5.x` to the git clone command.
2013-06-19 17:50:36 +02:00
### Configuring the build tree
Simply launch the configure script from a terminal:
2020-11-06 16:28:18 +01:00
```sh
2020-12-18 16:18:14 +01:00
./configure --with-matlab=< …>
2013-06-19 17:50:36 +02:00
```
2020-12-18 16:18:14 +01:00
where the path to MATLAB is specified.
2020-11-06 16:28:18 +01:00
Some important options:
2013-06-19 17:50:36 +02:00
2020-11-06 16:28:18 +01:00
- `--disable-matlab` : skip the compilation of MEX files for MATLAB
- `--disable-octave` : skip the compilation of MEX files for Octave
- `--disable-doc` : skip the compilation of the documentation (PDF and HTML)
2016-01-25 08:25:10 +01:00
2020-11-06 16:28:18 +01:00
You may need to specify additional options to the configure script, see the output of the `--help` option, and also the platform specific instructions below. If the configuration goes well, the script will tell you which components are correctly configured and will be built.
2013-06-19 17:50:36 +02:00
2019-05-22 14:47:16 +02:00
Note that it is possible that some MEX files cannot be compiled, due to missing
build dependencies. If you find no way of installing the missing dependencies,
a workaround can be to give up on compiling these MEX files and rather use
slower implementations (in the MATLAB/Octave language) that are available under
the `matlab/missing/mex/` subdirectories. For example, if you fail to compile
the gensylv MEX, you can type the following at the MATLAB/Octave prompt before
running Dynare:
```matlab
addpath < DYNARE_ROOT > /matlab/missing/mex/gensylv
```
(where you need to replace `<DYNARE_ROOT>` with the full path to your Dynare copy).
2017-01-26 10:28:41 +01:00
### Building
2013-06-19 17:50:36 +02:00
2020-11-06 16:28:18 +01:00
Binaries are built with:
```sh
2013-06-19 17:50:36 +02:00
make
```
PDF and HTML documentation are respectively built with:
2020-11-06 16:28:18 +01:00
```sh
2013-06-19 17:50:36 +02:00
make pdf
make html
```
2016-09-13 14:20:56 +02:00
2017-01-25 17:14:51 +01:00
### Check
2018-11-08 12:50:36 +01:00
The Git source comes with unit tests (in the MATLAB functions) and integration tests (under the `tests` subfolder). All the tests can be run with:
2020-12-18 16:14:31 +01:00
```sh
2017-01-25 17:14:51 +01:00
make check
```
2020-11-06 16:28:18 +01:00
in the `tests` subfolder. If Dynare has been compiled against MATLAB and Octave, the tests will be run with both MATLAB and Octave. Depending on the performance of your machine, this can take several hours. It is possible to run the tests only with MATLAB:
2020-12-18 16:14:31 +01:00
```sh
2017-01-25 17:14:51 +01:00
make check-matlab
```
or only with Octave:
2020-12-18 16:14:31 +01:00
```sh
2017-01-26 10:28:41 +01:00
make check-octave
2017-01-25 17:14:51 +01:00
```
2020-11-06 16:28:18 +01:00
Note that running the testsuite with Octave requires the additional packages `pstoedit` , `epstool` , `xfig` , and `gnuplot` .
A summary of the results is available in `tests/run_test_matlab_output.txt` or `tests/run_test_octave_output.txt` . Often, it does not make sense to run the complete testsuite. For instance, if you modify codes only related to the perfect foresight model solver, you can decide to run only a subset of the integration tests, with:
2020-12-18 16:14:31 +01:00
```sh
2017-01-25 17:14:51 +01:00
make deterministic_simulations
```
2018-11-08 12:50:36 +01:00
This will run all the integration tests in `tests/deterministic_simulations` with MATLAB and Octave. Again, it is possible to do this only with MATLAB:
2020-12-18 16:14:31 +01:00
```sh
2017-01-25 17:14:51 +01:00
make m/deterministic_simulations
```
or with Octave:
2020-12-18 16:14:31 +01:00
```sh
2017-01-25 17:14:51 +01:00
make o/deterministic_simulations
```
2018-11-08 12:50:36 +01:00
Finally if you want to run a single integration test, e.g. `deterministic_simulations/lbj/rbc.mod` with MATLAB:
2020-12-18 16:14:31 +01:00
```sh
2017-01-25 17:14:51 +01:00
make deterministic_simulations/lbj/rbc.m.trs
```
or with Octave:
2020-12-18 16:14:31 +01:00
```sh
2017-01-25 17:14:51 +01:00
make deterministic_simulations/lbj/rbc.o.trs
```
The result of the test (`PASSED` or `FAILED` ) will be printed in the terminal, the produced log can be displayed with:
2020-12-18 16:14:31 +01:00
```sh
2017-01-25 17:14:51 +01:00
make deterministic_simulations/lbj/rbc.m.drs
```
or
2020-12-18 16:14:31 +01:00
```sh
2017-01-25 17:14:51 +01:00
make deterministic_simulations/lbj/rbc.o.drs
```
2017-01-26 10:28:41 +01:00
Note that only tests will be executed where the `m.trs/o.trs` does not yet exist. You can run
2020-12-18 16:14:31 +01:00
```sh
2017-01-26 10:28:41 +01:00
make clean
```
in the `tests` folder to delete files that were created by the run of the testsuite. You can also manually delete the desired `m.trs/o.trs` file(s).
2017-01-25 17:14:51 +01:00
2013-06-19 17:50:36 +02:00
## Debian or Ubuntu
2018-11-06 17:05:05 +01:00
All the prerequisites are packaged:
2013-06-19 17:50:36 +02:00
2023-04-28 12:00:25 +02:00
- `gcc`
- `g++`
2015-01-21 11:18:10 +01:00
- `gfortran`
2023-04-28 12:00:25 +02:00
- `make`
- `octave-dev` (or `liboctave-dev` on older Debian/Ubuntu releases)
2019-09-11 14:59:25 +02:00
- `libboost-graph-dev`
2018-11-06 17:05:05 +01:00
- `libgsl-dev`
2013-06-19 17:50:36 +02:00
- `libmatio-dev`
- `libslicot-dev` and `libslicot-pic`
2013-12-16 15:07:16 +01:00
- `libsuitesparse-dev`
2022-02-07 12:06:52 +01:00
- `flex` and `libfl-dev`
2013-06-19 17:50:36 +02:00
- `bison`
- `autoconf`
- `automake`
- `texlive`
- `texlive-publishers` (for Econometrica bibliographic style)
- `texlive-latex-extra` (for fullpage.sty)
2016-08-23 21:51:00 +02:00
- `texlive-fonts-extra` (for ccicons)
2018-11-06 17:05:05 +01:00
- `texlive-science` (for amstex)
2020-02-04 10:22:35 +01:00
- `texlive-plain-generic`
2017-06-29 12:01:24 +02:00
- `lmodern` (for macroprocessor PDF)
2019-02-21 16:58:18 +01:00
- `python3-sphinx`
2021-11-13 20:38:43 +01:00
- `tex-gyre`
2019-10-01 13:40:31 +02:00
- `latexmk`
2019-02-21 16:58:18 +01:00
- `libjs-mathjax`
2013-06-19 17:50:36 +02:00
- `doxygen`
2020-11-06 16:28:18 +01:00
- `x13as`
2013-06-19 17:50:36 +02:00
2018-11-06 17:05:05 +01:00
You can install them all at once with:
2020-12-18 16:14:31 +01:00
```sh
2023-04-28 12:00:25 +02:00
apt install gcc g++ gfortran make octave-dev libboost-graph-dev libgsl-dev libmatio-dev libslicot-dev libslicot-pic libsuitesparse-dev flex libfl-dev bison autoconf automake texlive texlive-publishers texlive-latex-extra texlive-fonts-extra texlive-science texlive-plain-generic lmodern python3-sphinx tex-gyre latexmk libjs-mathjax doxygen x13as
2018-07-18 11:04:46 +02:00
```
2020-11-06 16:28:18 +01:00
If you use MATLAB, we strongly advise to also `apt install matlab-support` and confirm to rename the GCC libraries shipped with MATLAB to avoid possible conflicts with GCC libraries shipped by your distribution.
Tested on
2021-11-13 20:38:43 +01:00
- Debian “Buster” 10
- Debian “Bullseye” 11
2020-11-06 16:28:18 +01:00
- Ubuntu 20.04
- Ubuntu 20.10
2018-07-18 11:04:46 +02:00
2020-11-10 15:41:27 +01:00
## Fedora, CentOS or RHEL
2020-11-06 15:19:46 +01:00
Almost all prerequisites are packaged:
- `gcc` , `gcc-c++` , `make`
- `gcc-gfortran`
- `boost-devel`
- `gsl-devel`
- `matio-devel`
- `suitesparse-devel`
- `flex`
- `bison`
- `autoconf`
- `automake`
- `redhat-rpm-config`
- `octave` , `octave-devel` , `octave-statistics` , `octave-io` , `octave-optim` , `octave-control`
- `texlive-scheme-minimal` , `texlive-collection-publishers` , `texlive-collection-latexextra` , `texlive-collection-fontsextra` , `texlive-collection-latexrecommended` , `texlive-collection-science` , `texlive-collection-plaingeneric` , `texlive-lm`
- `python3-sphinx`
- `latexmk`
- `mathjax`
- `doxygen`
You can install them all at once with:
```sh
# Minimal packages (use --disable-doc and --disable-octave flags)
2023-01-03 23:39:44 +01:00
dnf install -y gcc gcc-c++ make gcc-gfortran boost-devel gsl-devel matio-devel suitesparse-devel flex bison autoconf automake redhat-rpm-config
2020-11-06 15:19:46 +01:00
# Octave packages (use --disable-doc flag)
dnf install octave octave-devel octave-statistics octave-io octave-optim octave-control
# Documentation packages
dnf install texlive-scheme-minimal texlive-collection-publishers texlive-collection-latexextra texlive-collection-fontsextra texlive-collection-latexrecommended texlive-collection-science texlive-collection-plaingeneric texlive-lm python3-sphinx latexmk mathjax doxygen
```
2020-11-10 15:41:27 +01:00
In Fedora these are available from the default repositories; whereas for CentOS and RHEL you need to enable the [Extra Packages for Enterprise Linux (EPEL) ](https://fedoraproject.org/wiki/EPEL ) repository and either the PowerTools repository for CentOS or the CodeReady Linux Builder repository for RHEL:
```sh
yum install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
# CentOS 8
dnf config-manager --set-enabled PowerTools
# RHEL 8
ARCH=$( /bin/arch )
subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms"
```
The documentation packages have slightly different names in CentOS and RHEL, you can also choose to pass the `--disable-doc` flag to your configure script to skip these dependencies.
2020-11-06 15:19:46 +01:00
2020-11-09 11:19:59 +01:00
`Slicot` and `x13as` need to be compiled from source:
2020-11-06 15:19:46 +01:00
```sh
# compile slicot from source and put it into /home/$USER/dynare/slicot/lib/
mkdir -p /home/$USER/dynare/slicot
cd /home/$USER/dynare/slicot
wget https://deb.debian.org/debian/pool/main/s/slicot/slicot_5.0+20101122.orig.tar.gz
tar xf slicot_5.0+20101122.orig.tar.gz
cd slicot-5.0+20101122
make FORTRAN=gfortran OPTS="-O2 -fPIC -fdefault-integer-8" LOADER=gfortran lib
mkdir -p /home/$USER/dynare/slicot/lib
cp slicot.a /home/$USER/dynare/slicot/lib/libslicot64_pic.a #for matlab
cp slicot.a /home/$USER/dynare/slicot/lib/libslicot_pic.a #for octave
# compile x13as from source and put it into /usr/bin/
mkdir -p /home/$USER/dynare/x13as
cd /home/$USER/dynare/x13as
2023-02-28 17:45:52 +01:00
wget https://www2.census.gov/software/x-13arima-seats/x13as/unix-linux/program-archives/x13as_asciisrc-v1-1-b59.tar.gz
tar xf x13as_asciisrc-v1-1-b59.tar.gz
2020-11-06 15:19:46 +01:00
sed -i "s|-static| |" makefile.gf # this removes '-static' in the makefile.gf
make -f makefile.gf FFLAGS="-O2 -std=legacy" PROGRAM=x13as
sudo cp x13as /usr/bin/
```
If you use MATLAB, we strongly advise to also rename or exclude the GCC libraries shipped with MATLAB to avoid possible conflicts with GCC libraries shipped by Fedora, see e.g. [Matlab on Fedora 33 ](https://mutschler.eu/linux/install-guides/fedora-post-install/#matlab ) or [MATLAB-ArchWiki ](https://wiki.archlinux.org/index.php/MATLAB ) for instructions.
Keep in mind to use the `--with-slicot` option to the configure command, e.g.:
```sh
cd /home/$USER/dynare
git clone --recurse-submodules https://git.dynare.org/dynare/dynare.git unstable
cd unstable
autoreconf -si
./configure --with-slicot=/home/$USER/dynare/slicot --with-matlab=/usr/local/MATLAB/R2020b
make -j$(($(nproc)+1)) #rule of thumb: one more than CPUs as shown by e.g. lscpu
```
2020-11-09 11:19:59 +01:00
If your distribution ships an older version of `bison` , compile it from source and append it *temporarily* to your path before calling the configure script:
```sh
bison --version # bison (GNU Bison) 3.0.4
mkdir -p /home/$USER/dynare/bison
cd /home/$USER/dynare/bison
wget http://ftp.gnu.org/gnu/bison/bison-3.6.4.tar.gz #change the version number accordingly
tar xf bison-3.6.4.tar.gz
cd bison-3.6.4
./configure --prefix=/home/$USER/dynare/bison
make
make install
export PATH=/home/$USER/dynare/bison/bin:$PATH
bison --version # bison (GNU Bison) 3.6.4
```
Now configure dynare as above.
2020-11-06 15:19:46 +01:00
Tested on
2020-11-10 15:41:27 +01:00
- CentOS 8
2020-11-06 15:19:46 +01:00
- Fedora Workstation 32
- Fedora Workstation 33
2020-11-09 11:19:59 +01:00
- Red Hat Enterprise Linux 8
2020-11-06 15:19:46 +01:00
2013-06-19 17:50:36 +02:00
## Windows
2021-10-08 12:18:15 +02:00
- Install [MSYS2 ](http://www.msys2.org )
2018-11-06 16:48:20 +01:00
- Run a MSYS MinGW 64-bit shell
2018-11-06 17:59:23 +01:00
- Update the system:
2020-12-18 16:14:31 +01:00
```sh
2018-11-06 17:59:23 +01:00
pacman -Syu
```
You may be asked to close the window at the end of the
first upgrade batch, in which case you should rerun the upgrade in a new
window to complete the upgrade.
2018-11-06 16:48:20 +01:00
- Install all needed dependencies:
2020-12-18 16:14:31 +01:00
```sh
2023-01-03 23:39:44 +01:00
pacman -S git autoconf automake-wrapper bison flex make tar texinfo mingw-w64-x86_64-gcc mingw-w64-x86_64-gcc-fortran mingw-w64-x86_64-boost mingw-w64-x86_64-gsl mingw-w64-x86_64-matio
2018-11-06 16:48:20 +01:00
```
2020-02-20 12:30:53 +01:00
- Compile and install SLICOT, needed for the `kalman_steady_state` MEX file
2020-12-18 16:14:31 +01:00
```sh
2018-11-06 16:48:20 +01:00
wget https://deb.debian.org/debian/pool/main/s/slicot/slicot_5.0+20101122.orig.tar.gz
tar xf slicot_5.0+20101122.orig.tar.gz
cd slicot-5.0+20101122
2020-02-20 12:30:53 +01:00
make FORTRAN=gfortran OPTS="-O2 -fno-underscoring -fdefault-integer-8" LOADER=gfortran lib
2018-11-06 16:48:20 +01:00
mkdir -p /usr/local/lib
cp slicot.a /usr/local/lib/libslicot64_pic.a
cd ..
```
2020-02-20 12:30:53 +01:00
- Prepare the Dynare sources, either by unpacking the source tarball, or with:
2020-12-18 16:14:31 +01:00
```sh
2019-04-16 15:36:24 +02:00
git clone --recurse-submodules https://git.dynare.org/Dynare/dynare.git
2018-11-06 16:48:20 +01:00
cd dynare
autoreconf -si
```
2020-02-20 12:30:53 +01:00
- Configure Dynare from the source directory:
2020-12-18 16:14:31 +01:00
```sh
2020-09-30 17:50:24 +02:00
./configure --with-slicot=/usr/local --with-matlab=< …> --disable-octave --disable-doc
2018-11-06 16:48:20 +01:00
```
2020-09-30 17:50:24 +02:00
where the path of MATLAB is specified. Note that you should use
2018-11-08 13:00:43 +01:00
the MSYS2 notation and not put spaces in the MATLAB path, so you probably want
2020-03-12 15:09:54 +01:00
to use something like `/c/Progra~1/MATLAB/…` . Alternatively, if your filesystem
does not have short filenames (8dot3), then you can run `mkdir -p
/usr/local/MATLAB && mount c:/Program\ Files/MATLAB /usr/local/MATLAB`, and
then pass `/usr/local/MATLAB/…` as MATLAB path to the configure script.
2018-11-06 16:48:20 +01:00
- Compile:
2020-12-18 16:14:31 +01:00
```sh
2018-11-06 16:48:20 +01:00
make
```
2018-11-21 16:21:46 +01:00
- Run the testsuite:
2020-12-18 16:14:31 +01:00
```sh
2018-11-21 16:21:46 +01:00
make -C tests check-matlab
```
2018-11-06 16:48:20 +01:00
2018-11-08 12:50:36 +01:00
**Note:** The above assumes that you have a 64-bit version of MATLAB. It can be
2018-11-06 16:48:20 +01:00
adapted to a 32-bit MATLAB with the following modifications:
- run the MSYS MinGW 32-bit shell
2018-11-08 12:50:36 +01:00
- replace `x86_64` by `i686` in packages names on the `pacman` command-line
2018-11-06 16:48:20 +01:00
- for SLICOT, remove the `-fdefault-integer-8` option, and instead copy the
library into `/usr/local/lib/libslicot_pic.a`
2018-11-08 12:50:36 +01:00
**Note:** Compiling the MEX files for Octave and the documentation under MSYS2 is
2018-11-06 16:48:20 +01:00
currently not supported.
2013-06-19 17:50:36 +02:00
2018-02-13 16:38:50 +01:00
## macOS
2023-04-25 22:29:23 +02:00
2022-01-04 14:18:07 +01:00
Dynare supports both Intel and Apple Silicon chips and is compiled from source
2023-04-25 22:29:23 +02:00
using a [Homebrew ](https://brew.sh/ ) toolchain. If you have an Apple silicon processor
(*M1/M2 PRO/MAX/ULTRA*), you can compile Dynare both for Intel's `x86_64` (using Rosetta 2)
as well as Apple's native `arm64` platform by using the corresponding Homebrew packages.
If you have an Intel chip you can only compile for `x86_64` .
2018-02-13 16:38:50 +01:00
2023-04-25 22:29:23 +02:00
You can check the platform of your current Homebrew installation by e.g. running
`which brew` which should point to `/opt/homebrew/bin/brew` for `arm64` and to
`/usr/local/bin/brew` for `x86_64` systems. In the steps below, we
2023-06-07 10:46:16 +02:00
create a temporary environment variable `BREWDIR` to ensure that the correct packages are used.
2013-06-19 17:50:36 +02:00
2023-04-25 22:29:23 +02:00
The following commands install all requirements and Dynare from source.
They should be entered at the command prompt in Terminal.app.
2022-01-04 14:18:07 +01:00
### Preparatory work
2023-04-25 22:29:23 +02:00
- Install the Xcode Command Line Tools:
```sh
xcode-select --install
```
2022-01-04 14:18:07 +01:00
- Install Rosetta 2 (Apple Silicon only):
```sh
softwareupdate --install-rosetta --agree-to-license
```
2023-04-25 22:29:23 +02:00
- Install [Homebrew ](https://brew.sh/ ):
2023-06-07 10:46:16 +02:00
Create environment variables for which platform you want to compile for, i.e. either `arm64` or `x86_64` :
2023-04-25 22:29:23 +02:00
For `arm64` run the following commands:
2020-12-18 16:14:31 +01:00
```sh
2023-04-25 22:29:23 +02:00
export ARCH=arm64
export BREWDIR=/opt/homebrew
2020-12-18 16:14:31 +01:00
```
2022-01-04 14:18:07 +01:00
2023-04-25 22:29:23 +02:00
For `x86_64` run the following commands:
```sh
export ARCH=x86_64
export BREWDIR=/usr/local
```
2023-06-07 10:46:16 +02:00
Install Homebrew using the environment variables:
2022-01-04 14:18:07 +01:00
```sh
2023-04-25 22:29:23 +02:00
arch -$ARCH /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
2022-01-04 14:18:07 +01:00
```
2023-04-25 22:29:23 +02:00
The prefix `arch -arm64` or `arch -x86_64` makes sure that you are installing the correct packages.
Don't forget to run the displayed commands (**Next steps**) in the terminal to add Homebrew to your PATH.
2022-01-04 14:18:07 +01:00
2023-04-25 22:29:23 +02:00
If you have both Homebrew installations installed, make sure that you are accessing the correct packages by temporarily (!) prepending it to the path:
2022-01-04 14:18:07 +01:00
```sh
2023-04-25 22:29:23 +02:00
export PATH="$BREWDIR/bin:$PATH"
2022-01-04 14:18:07 +01:00
```
2023-04-25 22:29:23 +02:00
2022-01-04 14:18:07 +01:00
- Install required Homebrew packages and link sphinx-doc:
2020-12-18 16:14:31 +01:00
```sh
2023-04-25 22:29:23 +02:00
arch -$ARCH $BREWDIR/bin/brew install automake bison flex boost gcc gsl libmatio veclibfort octave sphinx-doc docutils wget
```
If you want to compile the documentation, you need to link sphinx-doc:
```sh
arch -$ARCH $BREWDIR/bin/brew link --force sphinx-doc
2020-12-18 15:11:47 +01:00
```
2023-04-25 22:29:23 +02:00
Otherwise add `--disable-doc` flag to the `configure` command below, if you want to skip this.
2022-01-04 14:18:07 +01:00
2023-04-25 22:29:23 +02:00
- Install [MacTeX ](http://www.tug.org/mactex/index.html ) using the universal installer. MacTeX runs natively on both ARM and Intel machines. On Apple Silicon, it is advised to symlink `pdflatex` and `bibtex` into `/usr/local/bin` :
2022-01-04 14:18:07 +01:00
```sh
2023-04-25 22:29:23 +02:00
sudo ln -s /Library/TeX/texbin/pdflatex /usr/local/bin/pdflatex
sudo ln -s /Library/TeX/texbin/bibtex /usr/local/bin/bibtex
2022-01-04 14:18:07 +01:00
```
Alternatively, if you don’ t want to install MacTeX, you should pass the `--disable-doc` flag to the `configure` command below.
2023-04-25 22:29:23 +02:00
- Install MATLAB and additional toolboxes.
We recommend, but don't require, the following: Optimization, Global Optimization, Statistics and Machine Learning, Econometrics, and Control System.
For Apple Silicon: MATLAB offers a native Apple silicon version of R2022b as an open beta. You can sign up and install it (including a suitable Java 8 JRE, e.g. Amazon Corretto 8) using
[the official instructions ](https://de.mathworks.com/support/apple-silicon-r2022b-beta.html ).
Unfortunately, this version does not support yet the Optimization, Global Optimization and Econometrics toolboxes.
If you need these, please run the Intel version (under Rosetta 2) instead.
Don't forget to run MATLAB at least once to make sure you have a valid license.
2022-01-04 14:18:07 +01:00
2023-04-25 22:29:23 +02:00
- Create a folder for Dynare and its dependencies
2020-12-18 16:14:31 +01:00
```sh
2023-04-25 22:29:23 +02:00
export DYNAREDIR=$HOME/dynare
```
- Compile and install SLICOT, needed for e.g. the `kalman_steady_state` MEX file.
```sh
mkdir -p $DYNAREDIR/slicot/lib
cd $DYNAREDIR/slicot
curl -O https://deb.debian.org/debian/pool/main/s/slicot/slicot_5.0+20101122.orig.tar.gz
2020-12-18 15:11:47 +01:00
tar xf slicot_5.0+20101122.orig.tar.gz
cd slicot-5.0+20101122
2023-04-25 22:29:23 +02:00
make -j$(sysctl -n hw.ncpu) FORTRAN=$BREWDIR/bin/gfortran OPTS="-O2" LOADER=gfortran lib
cp slicot.a $DYNAREDIR/slicot/lib/libslicot_pic.a
2020-12-18 15:11:47 +01:00
make clean
2023-04-25 22:29:23 +02:00
make -j$(sysctl -n hw.ncpu) FORTRAN=$BREWDIR/bin/gfortran OPTS="-O2 -fdefault-integer-8" LOADER=gfortran lib
cp slicot.a $DYNAREDIR/slicot/lib/libslicot64_pic.a
2022-01-04 14:18:07 +01:00
cd $HOME/dynare
2020-12-18 15:11:47 +01:00
```
2018-02-13 17:45:42 +01:00
2022-01-04 14:18:07 +01:00
- Compile and install the X-13ARIMA-SEATS Seasonal Adjustment Program
```sh
2023-04-25 22:29:23 +02:00
mkdir -p $DYNAREDIR/x13as
cd $DYNAREDIR/x13as
curl -O https://www2.census.gov/software/x-13arima-seats/x13as/unix-linux/program-archives/x13as_asciisrc-v1-1-b59.tar.gz
2023-02-28 17:45:52 +01:00
tar xf x13as_asciisrc-v1-1-b59.tar.gz
2022-01-04 14:18:07 +01:00
sed -i '' 's/-static//g' makefile.gf
2023-06-07 11:16:21 +02:00
make -j$(sysctl -n hw.ncpu) -f makefile.gf FC=$BREWDIR/bin/gfortran LINKER=$BREWDIR/bin/gcc-13 FFLAGS="-O2 -std=legacy" LDFLAGS=-static-libgcc LIBS="$BREWDIR/lib/gcc/current/libgfortran.a /$BREWDIR/lib/gcc/current/libquadmath.a" PROGRAM=x13as
2023-04-25 22:29:23 +02:00
mkdir -p $HOME/.local/bin
cp x13as $HOME/.local/bin/x13as
2022-01-04 14:18:07 +01:00
cd ;
x13as
```
### Compile Dynare from source
2018-02-13 17:45:42 +01:00
The following commands will download the Dynare source code and compile
it. They should be entered at the command prompt in Terminal.app from the
2023-04-25 22:29:23 +02:00
folder where you want Dynare installed.
2018-02-13 17:45:42 +01:00
2022-01-04 14:18:07 +01:00
- Prepare the Dynare sources for the unstable version:
2020-12-18 16:14:31 +01:00
```sh
2023-04-25 22:29:23 +02:00
mkdir -p $DYNAREDIR/unstable
git clone --recurse-submodules https://git.dynare.org/Dynare/dynare.git $DYNAREDIR/unstable
cd $DYNAREDIR/unstable
arch -$ARCH autoreconf -si
2020-12-18 16:14:31 +01:00
```
2022-01-04 14:18:07 +01:00
You can also choose a specific version of Dynare by checking out the corresponding branch or a specific tag with git.
2020-12-18 16:14:31 +01:00
- Configure Dynare from the source directory:
```sh
2023-06-07 11:16:21 +02:00
arch -$ARCH ./configure --prefix=$BREWDIR CC=gcc-13 CXX=g++-13 CPPFLAGS=-I$BREWDIR/include LDFLAGS=-L$BREWDIR/lib LEX=$BREWDIR/opt/flex/bin/flex YACC=$BREWDIR/opt/bison/bin/bison --with-slicot=$DYNAREDIR/slicot --with-matlab=/Applications/MATLAB_R2022b_Beta.app
2020-12-18 16:14:31 +01:00
```
2023-04-25 22:29:23 +02:00
where you need to adapt the path to MATLAB. If you don’ t have MATLAB, simply replace `--with-matlab=<…>` by `--disable-matlab` .
Similarly, if you don't want to compile for Octave add a `--disable-octave` flag.
Check the output of the command whether Dynare is configured for building everything except the internal docs of Dynare and M2HTML.
2022-01-04 14:18:07 +01:00
2020-12-18 16:14:31 +01:00
- Compile:
```sh
2023-04-25 22:29:23 +02:00
arch -$ARCH make -j$(sysctl -n hw.ncpu)
```
If no errors occured, you are done. Dynare is now ready to use.
If you additionally want to compile the documentation run:
```sh
arch -$ARCH make pdf
arch -$ARCH make html
2020-12-18 16:14:31 +01:00
```
2022-01-04 14:18:07 +01:00
### Optional: pass the full PATH to MATLAB to run system commands
2023-04-25 22:29:23 +02:00
If you start MATLAB from a terminal, you will get the PATH inherited from the shell.
However, when you click on the application icon in macOS, you are not running at the terminal level:
the program is run by launcher, which does not go through a shell login session.
In other words, you get the system default PATH which includes `/usr/bin:/bin:/usr/sbin:/sbin` , but not `/usr/local/bin` or `$HOME/.local/bin` .
So if you want to use system commands like `pdflatex` or `x13as` you should either call them by their full path (e.g `/Library/TeX/texbin/pdflatex` )
or append the PATH in MATLAB by running `setenv('PATH', [getenv('PATH') ':/usr/local/bin:$HOME/.local/bin:/Library/TeX/texbin']);` .
Alternatively, you can create a `startup.m` file or change the system default PATH in the `/etc/paths` file.
2022-01-04 14:18:07 +01:00
2023-04-25 22:29:23 +02:00
Last tested on:
2023-06-07 11:16:21 +02:00
- macOS Ventura 13.3.1 (MacBook Air M1, MacBook Pro M2 MAX, M2 Virtual Machine using Parallels, Intel Virtual Machine using Quickemu)
2023-07-09 11:09:36 +02:00
## Docker
We offer a variety of pre-configured Docker containers for Dynare, pre-configured with Octave and MATLAB including all recommended toolboxes.
These are readily available for your convenience on [Docker Hub ](https://hub.docker.com/r/dynare/dynare ).
The docker folder contains [information and instructions ](docker/README.md ) to interact, built and customize the containers.