Skip to content
Snippets Groups Projects
Commit e772de90 authored by sebastien's avatar sebastien
Browse files

v4 packaging: 

* Windows: improved on README.txt
* Debian/Ubuntu: added copyright, README.Debian, and lintian override for empty directories


git-svn-id: https://www.dynare.org/svn/dynare/dynare_v4@1945 ac1d8469-bf42-47a9-8791-bf33cf982152
parent eeb0bee2
No related branches found
No related tags found
No related merge requests found
Show whitespace changes
Inline Side-by-side
debian/README.Debian 0 → 100644
+ 104
− 0
View file @ e772de90
Dynare version 4
================
Dynare is now installed on your Debian system in '/usr/lib/dynare'.
You can get more information on the web, on Dynare homepage:
http://www.dynare.org
Or on Dynare Wiki:
http://www.cepremap.cnrs.fr/DynareWiki
Using Dynare with Matlab
------------------------
Dynare requires Matlab version 6.5 or above. With older versions of Matlab, it
may fail or give unexpected results.
To use Dynare, you just have to add the 'matlab' subdirectory of your Dynare
installation to Matlab's path. You have two options for doing that:
* Use the addpath command, by typing the following:
addpath /usr/lib/dynare/matlab
Matlab will not remember this setting next time you run it, and you will have
to do it again.
* Select the "Set Path" entry in the "File" menu, then click on "Add
Folder...", and select the '/usr/lib/dynare/matlab' directory. Note that you
SHOULD NOT use "Add with Subfolders...". Apply the settings by clicking on
"Save". Note that Matlab will remember this setting next time you run it.
You can test your installation by typing 'dynare' at the Matlab prompt. This
should give you an error message complaining that you did not specify a MOD
file.
Using Dynare with Octave
------------------------
Dynare is now available for Octave, a free clone of Matlab (see
<http://www.octave.org>).
Octave should already be installed on your system, as a dependency of the
Dynare package.
Every time you run Octave, you should type the two following commands:
addpath /usr/lib/dynare/matlab
mark_as_command dynare
NOTE: if you don't want to type these two commands every time you run Octave,
you can put them in a file called '.octaverc' in your home directory. This file
is run by Octave at every startup.
You can test your installation by typing 'dynare' at the Octave prompt. This
should give you an error message complaining that you did not specify a MOD
file.
For more information about Dynare for Octave, go to:
http://www.cepremap.cnrs.fr/DynareWiki/DynareOctave
Dynamic Loadable Libraries
--------------------------
For better performance, some parts of Dynare are written in the C++ language,
which is faster than standard M-files. These parts are compiled and distributed
as dynamic loadable libraries (DLL), located in the 'mex' subdirectory of your
Dynare installation.
If the DLL are correctly detected by Matlab or Octave, the following should be
displayed when you launch Dynare:
Configuring Dynare ...
[mex] Generalized QZ.
[mex] Sylvester equation solution.
[mex] Kronecker products.
[mex] Sparse kronecker products.
On the contrary, if DLL are not detected, Dynare will fallback on slower
alternatives written in M-files, and display the following:
Configuring Dynare ...
[m] Generalized QZ.
[m] Sylvester equation solution.
[m] Kronecker products.
[m] Sparse kronecker products.
In this last case, Dynare will run correctly, but with suboptimal speed. There
could be several reasons for Matlab or Octave failing to detect the DLL:
* Your path settings may be wrong. Make sure that the 'matlab' subdirectory of
your Dynare installation is the only Dynare directory present in the path
variable.
* Your Matlab or Octave version may be incompatible with the provided binaries.
* You may have a custom M-file in your search path with the same name than a
DLL, therefore overriding it.
debian/control
+ 4
− 3
View file @ e772de90
...@@ -2,7 +2,7 @@ Source: dynare ...@@ -2,7 +2,7 @@ Source: dynare
Maintainer: Sébastien Villemot <sebastien.villemot@ens.fr> Maintainer: Sébastien Villemot <sebastien.villemot@ens.fr>
Section: math Section: math
Priority: optional Priority: optional
Build-Depends: debhelper (>= 6), octave3.0-headers, g++-4.1 Build-Depends: debhelper (>= 6), octave3.0-headers, g++-4.1, flex, bison
Standards-Version: 3.8.0 Standards-Version: 3.8.0
Homepage: http://www.dynare.org Homepage: http://www.dynare.org
...@@ -20,9 +20,10 @@ Description: Software suite for non-linear models with forward looking variables ...@@ -20,9 +20,10 @@ Description: Software suite for non-linear models with forward looking variables
This package contains: This package contains:
* the binary preprocessor * the binary preprocessor
* the various M-files which can be run under both Octave and Matlab (R) * the various M-files which can be run under both Octave and Matlab (R)
* dynamic libraries for faster computation, compiled for Octave * dynamic loadable libraries for faster computation, compiled for Octave
. .
For dynamic libraries compiled for Matlab (R), see dynare-matlab* packages. For dynamic loadable libraries compiled for Matlab (R), have a look at
dynare-matlab* packages.
Package: dynare-matlab7.4 Package: dynare-matlab7.4
Architecture: any Architecture: any
......
debian/copyright 0 → 100644
+ 46
− 0
View file @ e772de90
Upstream source for Dynare can be found on:
http://www.dynare.org
It can also be downloaded via subversion at:
http://www.cepremap.cnrs.fr/svn/
Debian packaging was done by Sébastien Villemot <sebastien.villemot@ens.fr>.
Copyright notice for software
-----------------------------
Most Dynare source files are copyright 1996-2008 Dynare Team. There are some
exceptions to this, which are described in source file headers when relevant.
Dynare is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
On Debian systems, the complete text of the GNU General Public License can be
found in `/usr/share/common-licenses/GPL-3'.
Copyright notice for documentation
----------------------------------
Permission is granted to copy, distribute and/or modify Dynare documentation
files under the terms of the GNU Free Documentation License, Version 1.2 or any
later version published by the Free Software Foundation; with no Invariant
Sections, no Front-Cover Texts, and no Back-Cover Texts.
On Debian systems, the complete text of the GNU Free Documentation License can
be found in `/usr/share/common-licenses/GFDL-1.2'.
Credits
-------
Matlab is a registered trademark of The Mathworks, Inc.
debian/dynare.lintian-overrides 0 → 100644
+ 2
− 0
View file @ e772de90
dynare: package-contains-empty-directory usr/lib/dynare/mex/2007b/
dynare: package-contains-empty-directory usr/lib/dynare/mex/2007a/
debian/rules
+ 1
− 0
View file @ e772de90
...@@ -55,6 +55,7 @@ binary-arch: build ...@@ -55,6 +55,7 @@ binary-arch: build
dh_install dh_install
dh_installchangelogs dh_installchangelogs
dh_installdocs dh_installdocs
-dh_lintian # Do not fail here, since dh_lintian is only present in debhelper >= 6.0.7, and Ubuntu Hardy has 6.0.4
dh_strip dh_strip
dh_compress dh_compress
dh_fixperms dh_fixperms
......
windows/README.txt
+ 79
− 25
View file @ e772de90
...@@ -2,23 +2,23 @@ Dynare version 4 ...@@ -2,23 +2,23 @@ Dynare version 4
================ ================
For information about how to use Dynare, you should have a look at the For information about how to use Dynare, you should have a look at the
documentation located in the doc/ subdirectory of your Dynare installation (you documentation located in the 'doc' subdirectory of your Dynare installation (you
should have a shortcut in your Start Menu to access it directly). should have a shortcut in your Start Menu to access it directly).
Beginners should start with the Dynare user guide. There is also a complete Beginners should start with the Dynare user guide. There is also a complete
reference manual documenting all Dynare functions in manual/index.html (however reference manual documenting all Dynare functions in 'manual\index.html' (however
note that it is a bit outdated). note that it is a bit outdated).
You can also get more information on the Dynare Wiki at: You can also get more information on the web, on Dynare homepage:
http://www.cepremap.cnrs.fr/DynareWiki http://www.dynare.org
You can also ask questions on the Dynare forums at: Or on Dynare Wiki:
http://www.dynare.org http://www.cepremap.cnrs.fr/DynareWiki
Note that Dynare comes with an automated uninstaller, which you can run from NOTE: Dynare comes with an automated uninstaller, which you can run from the
the "Add/Remove Programs" menu of the Control Panel. "Add/Remove Programs" menu of the Control Panel.
Using Dynare with Matlab Using Dynare with Matlab
...@@ -27,23 +27,25 @@ Using Dynare with Matlab ...@@ -27,23 +27,25 @@ Using Dynare with Matlab
Dynare requires Matlab version 6.5 or above. With older versions of Matlab, it Dynare requires Matlab version 6.5 or above. With older versions of Matlab, it
may fail or give unexpected results. may fail or give unexpected results.
To use Dynare, you just have to add the matlab/ subdirectory of your Dynare To use Dynare, you just have to add the 'matlab' subdirectory of your Dynare
installation to Matlab's path. You have two options for doing that: installation to Matlab's path. You have two options for doing that:
* Use the addpath command, by typing something like: * Use the addpath command, by typing the following (assuming that you have
installed Dynare at the standard location, and replacing '4.x.y' by correct
version number):
addpath DYNARE_INSTALLATION_DIRECTORY/matlab addpath c:\dynare\4.x.y\matlab
Matlab will not remember this setting next time you run it, and you will have Matlab will not remember this setting next time you run it, and you will have
to do it again. to do it again.
* Select the "Set Path" entry in the "File" menu, then click on "Add * Select the "Set Path" entry in the "File" menu, then click on "Add
Folder...", and select the matlab/ subdirectory of your Dynare Folder...", and select the 'matlab' subdirectory of your Dynare
installation. Note that you SHOULD NOT use "Add with Subfolders...". Apply installation. Note that you SHOULD NOT use "Add with Subfolders...". Apply
the settings by clicking on "Save". Note that Matlab will remember this the settings by clicking on "Save". Note that Matlab will remember this
setting next time you run it. setting next time you run it.
You can test your installation by typing "dynare" at the Matlab prompt. This You can test your installation by typing 'dynare' at the Matlab prompt. This
should give you an error message complaining that you did not specify a MOD should give you an error message complaining that you did not specify a MOD
file. file.
...@@ -58,37 +60,83 @@ For installing Octave on your Windows system, go to: ...@@ -58,37 +60,83 @@ For installing Octave on your Windows system, go to:
http://sourceforge.net/project/showfiles.php?group_id=2888&package_id=40078 http://sourceforge.net/project/showfiles.php?group_id=2888&package_id=40078
Then pick the "octave-3.0.1-vs2008-setup.exe" installer. Choose GNUplot Then pick the 'octave-3.0.1-vs2008-setup.exe' installer. Choose GNUplot
graphical backend (instead of JHandles) during installation. Also note that graphical backend (instead of JHandles) during installation. Also note that
this distribution contains a nice text editor, which you can invoke with "edit" this distribution contains a nice text editor, which you can invoke with "edit"
as you would under Matlab. as you would under Matlab.
WARNING: the Octave binary distribution has a bug which makes Octave crash WARNING: the Octave binary distribution has a bug which makes Octave crash
everytime one types clear all (and therefore everytime one runs Dynare!). A everytime one types 'clear all' (and therefore everytime one runs Dynare!). A
simple workaround is to type the following command the first time you run simple workaround is to type the following command the first time you run
Octave: Octave:
pkg rebuild -noauto ftp ann database pkg rebuild -noauto ftp ann database
Every time you run Octave, you should type the two following commands: Every time you run Octave, you should type the two following commands (assuming
that you have installed Dynare at the standard location, and replacing '4.x.y'
by correct version number):
addpath DYNARE_INSTALLATION_DIRECTORY/matlab mark_as_command dynare addpath c:\dynare\4.x.y\matlab
mark_as_command dynare
NOTE: if you don't want to type these two commands every time you run Octave, NOTE: if you don't want to type these two commands every time you run Octave,
you can put them in a file called ".octaverc" in your home directory (generally you can put them in a file called '.octaverc' in your home directory (generally
"c:\Documents and Settings\USERNAME\"). This file is run by Octave at every 'c:\Documents and Settings\USERNAME\'). This file is run by Octave at every
startup. startup.
You can test your installation by typing "dynare" at the Octave prompt. This You can test your installation by typing 'dynare' at the Octave prompt. This
should give you an error message complaining that you did not specify a MOD should give you an error message complaining that you did not specify a MOD
file. file.
For more information about Dynare for Octave, go to:
http://www.cepremap.cnrs.fr/DynareWiki/DynareOctave
Dynamic Loadable Libraries
--------------------------
For better performance, some parts of Dynare are written in the C++ language,
which is faster than standard M-files. These parts are compiled and distributed
as dynamic loadable libraries (DLL), located in the 'mex' subdirectory of your
Dynare installation.
If the DLL are correctly detected by Matlab or Octave, the following should be
displayed when you launch Dynare:
Configuring Dynare ...
[mex] Generalized QZ.
[mex] Sylvester equation solution.
[mex] Kronecker products.
[mex] Sparse kronecker products.
On the contrary, if DLL are not detected, Dynare will fallback on slower
alternatives written in M-files, and display the following:
Configuring Dynare ...
[m] Generalized QZ.
[m] Sylvester equation solution.
[m] Kronecker products.
[m] Sparse kronecker products.
In this last case, Dynare will run correctly, but with suboptimal speed. There
could be several reasons for Matlab or Octave failing to detect the DLL:
* Your path settings may be wrong. Make sure that the 'matlab' subdirectory of
your Dynare installation is the only Dynare directory present in the path
variable.
* Your Matlab or Octave version may be incompatible with the provided binaries.
* You may have a custom M-file in your search path with the same name than a
DLL, therefore overriding it.
Copyright notice for software Copyright notice for software
----------------------------- -----------------------------
Most Dynare source file are copyright "Dynare Team". There are some exceptions Most Dynare source files are copyright 1996-2008 Dynare Team. There are some
to this, which are described in source file headers when relevant. exceptions to this, which are described in source file headers when relevant.
Dynare is free software: you can redistribute it and/or modify it under the Dynare is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software terms of the GNU General Public License as published by the Free Software
...@@ -100,7 +148,7 @@ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A ...@@ -100,7 +148,7 @@ WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details. PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
this program (see gpl.txt). If not, see <http://www.gnu.org/licenses/>. this program (see 'gpl.txt'). If not, see <http://www.gnu.org/licenses/>.
Copyright notice for documentation Copyright notice for documentation
...@@ -111,4 +159,10 @@ files under the terms of the GNU Free Documentation License, Version 1.2 or any ...@@ -111,4 +159,10 @@ files under the terms of the GNU Free Documentation License, Version 1.2 or any
later version published by the Free Software Foundation; with no Invariant later version published by the Free Software Foundation; with no Invariant
Sections, no Front-Cover Texts, and no Back-Cover Texts. Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license can be found in the fdl.txt file. A copy of the license can be found in the 'fdl.txt' file.
Credits
-------
Matlab is a registered trademark of The Mathworks, Inc.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment