[Pkg-octave-commit] r2971 - dynare/trunk/debian

Thu Apr 23 14:46:16 UTC 2009

Author: sebastien-guest
Date: 2009-04-23 14:46:16 +0000 (Thu, 23 Apr 2009)
New Revision: 2971

Modified:
   dynare/trunk/debian/README.Debian
Log:
Updated README.Debian

Modified: dynare/trunk/debian/README.Debian
===================================================================

--- dynare/trunk/debian/README.Debian	2009-04-23 10:11:37 UTC (rev 2970)
+++ dynare/trunk/debian/README.Debian	2009-04-23 14:46:16 UTC (rev 2971)
@@ -1,105 +1,51 @@
-Dynare version 4
-================
+Dynare for Debian
+=================
 
-Dynare is now installed on your Debian system in '/usr/lib/dynare'.
+This package provides a fully functional installation of Dynare for GNU Octave.
 
-You can get more information on the web, on Dynare homepage:
+If your model file is called 'filename.mod', just type the following at the
+Octave prompt:
 
-  http://www.dynare.org
+  dynare('filename')
 
-Or on Dynare Wiki:
+If you prefer the short syntax for the 'dynare' command, type:
 
-  http://www.dynare.org/DynareWiki
+  mark_as_command dynare
+  dynare filename
 
+Note that the 'mark_as_command' statement can be put in your ~/.octaverc file.
 
-Using Dynare with Matlab (R)
-----------------------------
+Also note that you don't need to do any 'addpath', the Debian package does it
+for you.
 
-Dynare requires Matlab (R) version 6.5 or above. With older versions of Matlab (R),
-it may fail or give unexpected results.
 
-To use Dynare, you just have to add the 'matlab' subdirectory of your Dynare
-installation to Matlab (R) path. You have two options for doing that:
+Documentation
+-------------
 
-* Use the addpath command, by typing the following:
+Please install the 'dynare-doc' package for the user guide, the reference
+manual, and several other documentation files.
 
-    addpath /usr/lib/dynare/matlab
+You can find more information and model file examples, on Dynare homepage:
 
-  Matlab (R) will not remember this setting next time you run it, and you will
-  have to do it again.
+  http://www.dynare.org
 
-* 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 (R) will remember this setting next time you run it.
+Or on Dynare Wiki:
 
-You can test your installation by typing 'dynare' at the Matlab (R)
-prompt. This should give you an error message complaining that you did not
-specify a MOD file.
+  http://www.dynare.org/DynareWiki
 
+In particular, some specificities of Dynare for Octave are discussed on:
 
-Using Dynare with Octave
-------------------------
-
-Dynare is now available for Octave, a free clone of Matlab (R) (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.dynare.org/DynareWiki/DynareOctave
 
 
-Dynamic Loadable Libraries
---------------------------
+Note for MATLAB users
+---------------------
 
-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.
+Before using Dynare on MATLAB, you need to type the following:
 
-If the DLL are correctly detected by Matlab (R) or Octave, the following should
-be displayed when you launch Dynare:
+  addpath /usr/share/dynare/matlab
 
-  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 (R) 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 (R) 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.
+Note that the Debian package currently doesn't provide MEX files for
+MATLAB. However, it provides substitution functions in M-files. Therefore this
+package is fully function on MATLAB, but doesn't run at full speed. We hope to
+provide soon a helper for compilation of MEX files under MATLAB.


