Differences between revisions 13 and 107 (spanning 94 versions)

Precompiled binary packages of Dynare are available for Debian and Ubuntu distributions of GNU/Linux. These packages work with both Octave and MATLAB.

This page describes the installation of these packages.

1. Configuring your package manager to receive Dynare packages

This should be done only before the first installation.

Packages are available from two sources:

Official Debian and Ubuntu archives
Dynare repository

Depending on your version of Debian or Ubuntu, and the version of Dynare you want, you will want to choose one or the other of these two sources.

1.1. From official Debian and Ubuntu archive

Dynare is available in Debian and Ubuntu as an official package.

The status of the package can be monitored on the Debian Tracker.

Status of the packages as of 2018-02-03:

Distribution	Version of Dynare	Version of Octave used by the package
Debian Jessie 8 (oldstable)	4.4.3	3.8
Debian Stretch 9 (stable)	4.4.3	4.0
Debian Sid (unstable)	4.5.4	4.2
Ubuntu Trusty Tahr 14.04 (LTS)	4.4.1	3.8
Ubuntu Xenial Xerus 16.04 (LTS)	4.4.3	4.0

If you want to use these sources, you don't need to do anything: they are already configured in your package manager.

$/!\$ Under Debian, you may however need to select the "contrib" section in your package sources, in order to get MATLAB support.

$/!\$ These packages are guaranteed to be compatible with the version of Octave installed on your system. However, it may happen that your version of MATLAB is too recent for these packages (since MATLAB is not part of the release cycle of Debian and Ubuntu); if you experience inexplicable crashes/problems with MATLAB, then consider using the more recent Dynare packages in the following section.

1.2. From Dynare repository

Status of the packages as of 2014-08-01:

Distribution	Version of Dynare	Version of Octave used by the package	Supported archs	APT source line
Debian Squeeze 6.0 (oldstable)	4.4.3	3.6 (from squeeze-backports)	`amd64 i386`	`deb http://www.dynare.org/debian squeeze main contrib`
Debian Wheezy 7 (stable)	4.4.3	3.6	`amd64 i386`	`deb http://www.dynare.org/debian wheezy main contrib`
Ubuntu Precise Pangolin 12.04 (LTS)	4.4.3	3.8 (from Octave PPA)	`amd64 i386`	`deb http://www.dynare.org/ubuntu precise main contrib`
Ubuntu Trusty Tahr 14.04 (LTS)	4.4.3	3.8	`amd64 i386`	`deb http://www.dynare.org/ubuntu trusty main contrib`

Notes:

if you are using Debian Squeeze, you must configure backports as explained on the backports instructions page
if you are using Ubuntu Precise, you must configure the Octave/stable PPA as explained on the Octave wiki

1.2.1. Importing the cryptographic signing key

First, for security reasons, you should download the archive signing key, which is used to authenticate Dynare packages.

There are two ways of doing it:

via the graphical Synaptic package manager
- first download http://www.dynare.org/dynare.public.key, and save it somewhere
- then launch Synaptic, go to the "Settings" menu, and click on "Repositories"
- go to "Authentication" tab, and click on "Import Key file"
- select the dynare.public.key file that you have downloaded, and click OK
or manually, by typing the following in a command line (assuming you have installed wget):

sudo wget -O - http://www.dynare.org/dynare.public.key | sudo apt-key add -

1.2.2. Adding the correct APT line to your package sources

Then you need to give one "APT line" to your package manager; this line is given in the previous table, and depends on your distribution.

For adding them, you can either do it:

via the graphical Synaptic package manager:
- go to the "Settings" menu, and click on "Repositories"
- go to "Third-party software" tab and click on "Add"
- you will be asked for an APT line: copy/paste the APT line, then click "Add Source"
or manually, by editing your /etc/apt/sources.list with a text editor (as root), and adding the apt line

2. Installing the packages

There are three packages which you may want to install:

dynare: base package, containing a fully functional installation of Dynare for Octave under /usr/share/dynare/matlab
dynare-matlab: install this package if you are using MATLAB, in order to recompile the MEX files. You will be asked a few questions by your package manager (such as the location where you installed MATLAB)
dynare-doc: documentation (HTML and PDF manual, PDF userguide, example MOD files, ...). They are installed under /usr/share/doc/dynare-doc/. The manual and the userguide are also registered:
- in the DHelp/DWWW system, in the "Science/Mathematics" section
- in Rarian (the online help system in Gnome and KDE), in the "Education/Mathematics" section

3. Using Dynare

3.1. Under MATLAB

You need to specify the correct path, which depends on the version of Dynare.

For Dynare 4.4.2 and older:

addpath /usr/share/dynare/matlab

For Dynare 4.4.3 and later:

addpath /usr/lib/dynare/matlab

Then, launch Dynare with:

dynare filename.mod

3.2. Under Octave

You don't need to add a path, it's automatically configured.

Then, launch Dynare with:

dynare filename.mod

DynareWiki: InstallOnDebianOrUbuntu (last edited 2018-05-16 15:37:23 by SébastienVillemot)

-  ⇤ ← Revision 13 as of 2008-09-23 16:24:07 → 
  Size: 4948
  Editor: SébastienVillemot
  Comment:
+   ← Revision 107 as of 2018-02-03 21:00:30 → ⇥
  Size: 5714
  Editor: SébastienVillemot
  Comment: Dynare 4.5.4 uploaded to Debian
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
-= Installing Dynare on Debian or Ubuntu =
+#pragma section-numbers on
 Line 3:
-Since Dynare 4.0.0, precompiled binaries packages and source packages are available for Debian and Ubuntu distributions of GNU/Linux. These packages work with both Octave and Matlab. They are available through standard package repositories.
+Precompiled binary packages of Dynare are available for Debian and Ubuntu distributions of GNU/Linux. These packages work with both Octave and MATLAB.
 Line 5:
-== Availability ==
+This page describes the installation of these packages.
 Line 7:
-=== On Debian GNU/Linux ===

Packages are available for Lenny (the current testing and future stable distribution). They should also work on Sid (the unstable distribution).

The Etch (the current stable distribution, version 4.0) is not supported, since it does not provide Octave version 3.

Binaries are available for the i386 and amd64 architectures. See below for how to recompile the package if you use another architecture.

=== On Ubuntu ===

Packages are available for Hardy Heron (Ubuntu version 8.04). No other distribution is supported.

Binaries are available for the i386 and amd64 architectures. See below for how to recompile the package if you use another architecture.

== Adding the correct repository to APT sources ==
+= Configuring your package manager to receive Dynare packages =
-Line 25:
+Line 11:
-First, for security reasons, you should download the archive signing key, at [http://www.dynare.org/dynare.public.key], and then add it to your keyring with {{{apt-key add dynare.public.key}}}.
+Packages are available from two sources:
 * Official Debian and Ubuntu archives
 * Dynare repository
-Line 27:
+Line 15:
-This can be done in one step, assuming that you have installed {{{wget}}}:
+Depending on your version of Debian or Ubuntu, and the version of Dynare you want, you will want to choose one or the other of these two sources.

== From official Debian and Ubuntu archive ==

Dynare is available in Debian and Ubuntu as an official package.

The status of the package can be monitored on the [[https://tracker.debian.org/pkg/dynare|Debian Tracker]].

Status of the packages as of 2018-02-03:

|| '''Distribution''' || '''Version of Dynare''' || '''Version of Octave used by the package''' ||
|| Debian Jessie 8 (oldstable) || 4.4.3 || 3.8 ||
|| Debian Stretch 9 (stable) || 4.4.3 || 4.0 ||
|| Debian Sid (unstable) || 4.5.4 || 4.2 ||
|| Ubuntu Trusty Tahr 14.04 (LTS) || 4.4.1 || 3.8 ||
|| Ubuntu Xenial Xerus 16.04 (LTS) || 4.4.3 || 4.0 ||

If you want to use these sources, you don't need to do anything: they are already configured in your package manager.

/!\ Under Debian, you may however need to select the "contrib" section in your package sources, in order to get MATLAB support.

/!\ These packages are guaranteed to be compatible with the version of Octave installed on your system. However, it may happen that your version of MATLAB is too recent for these packages (since MATLAB is not part of the release cycle of Debian and Ubuntu); if you experience inexplicable crashes/problems with MATLAB, then consider using the more recent Dynare packages in the following section.

== From Dynare repository ==

Status of the packages as of 2014-08-01:

|| '''Distribution''' || '''Version of Dynare''' || '''Version of Octave used by the package''' || '''Supported archs''' || '''APT source line''' ||
|| Debian Squeeze 6.0 (oldstable) || 4.4.3 || 3.6 (from squeeze-backports) || {{{amd64 i386}}} || {{{deb http://www.dynare.org/debian squeeze main contrib}}} ||
|| Debian Wheezy 7 (stable) || 4.4.3 || 3.6 || {{{amd64 i386}}} || {{{deb http://www.dynare.org/debian wheezy main contrib}}} ||
|| Ubuntu Precise Pangolin 12.04 (LTS) || 4.4.3 || 3.8 (from Octave PPA) || {{{amd64 i386}}} || {{{deb http://www.dynare.org/ubuntu precise main contrib}}} ||
|| Ubuntu Trusty Tahr 14.04 (LTS) || 4.4.3 || 3.8 || {{{amd64 i386}}} || {{{deb http://www.dynare.org/ubuntu trusty main contrib}}} ||

Notes:
 * if you are using Debian Squeeze, you must configure backports as explained on [[http://backports.debian.org/Instructions/|the backports instructions page]]
 * if you are using Ubuntu Precise, you must configure the Octave/stable PPA as explained on [[http://wiki.octave.org/Debian|the Octave wiki]]



=== Importing the cryptographic signing key ===

First, for security reasons, you should download the archive signing key, which is used to authenticate Dynare packages.

There are two ways of doing it:
 * via the graphical Synaptic package manager
   * first download [[http://www.dynare.org/dynare.public.key]], and save it somewhere
   * then launch Synaptic, go to the "Settings" menu, and click on "Repositories"
   * go to "Authentication" tab, and click on "Import Key file"
   * select the {{{dynare.public.key}}} file that you have downloaded, and click OK
 * or manually, by typing the following in a command line (assuming you have installed {{{wget}}}):
-Line 29:
+Line 66:
-sudo wget -O - http://www.dynare.org/dynare.public.key | apt-key add -
+sudo wget -O - http://www.dynare.org/dynare.public.key | sudo apt-key add -
-Line 32:
+Line 69:
-Then modify your {{{sources.list}}} file, according to your Linux distribution:
+=== Adding the correct APT line to your package sources ===
-Line 34:
+Line 71:
-=== On Debian GNU/Linux ===
+Then you need to give one "APT line" to your package manager; this line is given in the previous table, and depends on your distribution.
-Line 36:
+Line 73:
-Edit your {{{/etc/apt/sources.list}}} (as root), and add the following two lines:
+For adding them, you can either do it:
 * via the graphical Synaptic package manager:
   * go to the "Settings" menu, and click on "Repositories"
   * go to "Third-party software" tab and click on "Add"
   * you will be asked for an APT line: copy/paste the APT line, then click "Add Source"
 * or manually, by editing your {{{/etc/apt/sources.list}}} with a text editor (as root), and adding the apt line

= Installing the packages =

There are three packages which you may want to install:

 * {{{dynare}}}: base package, containing a fully functional installation of Dynare for Octave under {{{/usr/share/dynare/matlab}}}
 * {{{dynare-matlab}}}: install this package if you are using MATLAB, in order to recompile the MEX files. You will be asked a few questions by your package manager (such as the location where you installed MATLAB)
 * {{{dynare-doc}}}: documentation (HTML and PDF manual, PDF userguide, example MOD files, ...). They are installed under {{{/usr/share/doc/dynare-doc/}}}. The manual and the userguide are also registered:
    * in the DHelp/DWWW system, in the "Science/Mathematics" section
    * in Rarian (the online help system in Gnome and KDE), in the "Education/Mathematics" section

= Using Dynare =

== Under MATLAB ==
You need to specify the correct path, which depends on the version of Dynare.

For Dynare 4.4.2 and older:
-Line 38:
+Line 97:
-deb http://www.dynare.org/debian lenny main contrib
deb-src http://www.dynare.org/debian lenny main
+addpath /usr/share/dynare/matlab
-Line 42:
+Line 100:
-=== On Ubuntu ===

Edit your {{{/etc/apt/sources.list}}} (with sudo), and add the following two lines:
{{{
deb http://www.dynare.org/ubuntu hardy main contrib
deb-src http://www.dynare.org/ubuntu hardy main
}}}

== Installing the package(s) ==

Using your favorite package manager (apt-get, aptitude, synaptic), update your package list. You should now see three new packages: {{{dynare}}}, {{{dynare-matlab7.4}}} and {{{dynare-matlab7.5}}}.

The {{{dynare}}} package contains a fully functional installation of Dynare for both Octave and Matlab. The installation is made under {{{/usr/lib/dynare}}}. The package contains: the preprocessor, the M-files, and the optimized dynamic libraries for Octave.

Since the {{{dynare}}} package does not contain optimized dynamic libraires for Matlab, you should install one of the two {{{dynare-matlab*}}} for full performance under Matlab:
 * the {{{dynare-matlab7.4}}} package was compiled with Matlab 7.4 (R2007a), and *may* work with older releases
 * the {{{dynare-matlab7.5}}} package was compiled with Matlab 7.5 (R2007b), and has been reported to work with Matlab 7.6 (R2008a)

The packages also contain documentation (HTML and PDF manual, PDF userguide, and other documents). These are installed in {{{/usr/share/doc/dynare}}}. The manual and the userguide are also registered in the DHelp system, and in scroolkeeper (the online help system in Gnome and KDE).

For the moment, the packages don't contain any example MOD-file, but this should change in the near future.

Don't forget to regularly run your package manager to get the most recent version of Dynare.

== Using Dynare ==

You can run Dynare from Octave or Matlab, by adding the correct path at runtime:
+For Dynare 4.4.3 and later:
-Line 72:
+Line 104:
-Under Octave, you may also want to type:
{{{
mark_as_command dynare
}}}
-Line 82:
+Line 111:
-Under Octave, it is possible to create a startup file which adds the correct path at every start. See DynareOctave on this topic and on other Octave-specific issues.
+== Under Octave ==
-Line 84:
+Line 113:
-== Compiling the package from source ==
+You don't need to add a path, it's automatically configured.
-Line 86:
+Line 115:
-You can be interested in recompiling the packages, especially if binaries for your architecture are not available.

Download and unpack the source in the current directory by typing:
+Then, launch Dynare with:
-Line 90:
+Line 117:
-apt-src install dynare
+dynare filename.mod
-Line 92:
+Line 119:
-(you may be asked the root password for installing packages necessary for the building process)

This should have created a {{{dynare-???}}} directory, where {{{???}}} is the current version number. Go into that directory, and type:
{{{
dpkg-buildpackage -b -uc
}}}
This should build the {{{dynare-???}}} package (in a {{{.deb}}} file), and also the {{{dynare-matlab7.4}}} (resp. {{{dynare-matlab7.5}}}) package if you have Matlab 7.4 (resp. 7.5) intalled under {{{/usr/local/matlab74}}} (resp. {{{/usr/local/matlab75}}}). You can tune the {{{debian/rules}}} file if your Matlab installation is located at another place.

''Note'': if you want to become the official Dynare package builder for your favourite architecture, please contact Dynare authors and we will distribute your binaries.