* created a Makefile for rebuilding the userguide
* integrated the building of the userguide in the Debian packaging
* removed PDF files of the userguide
* included the front cover directly from latex source
* updated some URLs in the userguide, to point to www.dynare.org


git-svn-id: https://www.dynare.org/svn/dynare/dynare_v4@2325 ac1d8469-bf42-47a9-8791-bf33cf982152
time-shift
sebastien 2008-12-18 21:39:49 +00:00
parent d8f667fdbf
commit 033de871e6
12 changed files with 45 additions and 12293 deletions

View File

@ -5,4 +5,4 @@ Abstract: Introduces the reader to Dynare features and usage
Section: Science/Mathematics
Format: PDF
Files: /usr/share/doc/dynare/DynareUserGuide_PublicBeta20081218.pdf
Files: /usr/share/doc/dynare/UserGuide.pdf

2
debian/dynare.docs vendored
View File

@ -4,4 +4,4 @@ doc/guide.pdf
doc/macroprocessor/macroprocessor.pdf
doc/bvar-a-la-sims.pdf
doc/preprocessor/preprocessor.pdf
doc/userguide/DynareUserGuide_PublicBeta20081218.pdf
doc/userguide/UserGuide.pdf

View File

@ -1,6 +1,7 @@
all: guide.pdf manual-html/index.html manual.pdf bvar-a-la-sims.pdf
make -C preprocessor
make -C macroprocessor
make -C userguide
guide.pdf: guide.tex guide.bbl bibmad.sty
pdflatex guide
@ -24,3 +25,4 @@ clean:
rm -rf manual.pdf manual-html
make -C preprocessor clean
make -C macroprocessor clean
make -C userguide clean

15
doc/userguide/Makefile Normal file
View File

@ -0,0 +1,15 @@
all: UserGuide.pdf
SRC = UserGuide.tex Graphics/DynareTitle.pdf DynareBib.bib \
ch-intro.tex ch-inst.tex ch-solbase.tex ch-soladv.tex ch-estbase.tex \
ch-estadv.tex ch-solbeh.tex ch-estbeh.tex ch-ramsey.tex ch-trouble.tex
UserGuide.pdf:
pdflatex UserGuide
bibtex UserGuide
pdflatex UserGuide
pdflatex UserGuide
clean:
rm -f *.log *.aux *.toc *.lof *.blg *.bbl *.out
rm -f UserGuide.pdf

File diff suppressed because one or more lines are too long

View File

@ -1,4 +1,4 @@
\documentclass[a4paper,11pt,titlepage]{memoir}
\documentclass[a4paper,11pt]{memoir}
\maxsecnumdepth{subsection}
\setsecnumdepth{subsection}
\maxtocdepth{subsection}
@ -11,6 +11,7 @@
\usepackage[applemac]{inputenc}
\usepackage{amsbsy,enumerate}
\usepackage{natbib}
\usepackage{pdfpages}
%\usepackage{makeidx}
%\usepackage[pdftex]{hyperref}
%\usepackage{hyperref}
@ -35,50 +36,31 @@ pdftex}
\begin{document}
\frontmatter
\includepdf{Graphics/DynareTitle.pdf}
\title{Dynare v4 - User Guide \\ÊPublic beta version}
\author{\\ \\ \\ \\ \\ \\ \\ \\ \\ \\ \\ Tommaso Mancini Griffoli\\ tommaso.mancini@stanfordalumni.org}
\date{This draft: March 2007}
\maketitle
\thispagestyle{empty}
\newpage
.\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
\\
Copyright © 2007-2008 Tommaso Mancini Griffoli\\
\\
\\
~\vfill
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.\\
\\
\\
Copyright © 2007-2008 Tommaso Mancini Griffoli
A copy of the license can be found at: http://www.gnu.org/licenses/fdl.txt\\
\bigskip
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
\bigskip
A copy of the license can be found at: \url{http://www.gnu.org/licenses/fdl.txt}
\vfill
\newpage
@ -90,7 +72,7 @@ This is the second version of the Dynare User Guide which is still work in progr
The second thing that a work in progress manuscript comes with is a few internal notes. These are mostly placeholders for future work, notes to myself or others of the Dynare development team, or at times notes to you - our readers - to highlight a feature not yet fully stable. Any such notes are marked with two stars (**). \\
Thanks very much for your patience and good ideas. Please write either direclty to myself: tommaso.mancini@stanfordalumni.org, or \textbf{preferably on the Dynare Documentation Forum} available in the Forum section of the \href{http://www.cepremap.cnrs.fr/juillard/mambo/index.php?option=com_forum&Itemid=95}{Dynare website}.
Thanks very much for your patience and good ideas. Please write either direclty to myself: tommaso.mancini@stanfordalumni.org, or \textbf{preferably on the Dynare Documentation Forum} available in the Forum section of the \href{http://www.dynare.org}{Dynare website}.
\chapter*{Contacts and Credits} \label{ch:contacts}
Dynare was originally developed by Michel Juillard in Paris, France. Currently, the development team of Dynare is composed of
@ -99,8 +81,8 @@ Dynare was originally developed by Michel Juillard in Paris, France. Currently,
\item StŽphane Adjemian (stephane.adjemian``AT''ens.fr)
\item Michel Juillard (michel.juillard``AT''ens.fr)
\item Ferhat Mihoubi (ferhat.mihoubi``AT''univ-evry.fr)
\item Ondra Kamenik (ondra.kamenik"AT"volny.cz)
\item Marco Ratto (marco.ratto"AT"jrc.it)
\item Ondra Kamenik (ondra.kamenik``AT''volny.cz)
\item Marco Ratto (marco.ratto``AT''jrc.it)
\item SŽbastien Villemot (sebastien.villemot``AT''ens.fr)
\end{itemize}
@ -108,7 +90,7 @@ Several parts of Dynare use or have strongly benefitted from publicly available
Finally, the development of Dynare could not have come such a long ways withough an active community of users who continually pose questions, report bugs and suggest new features. The help of this community is gratefully acknowledged.\\
The email addresses above are provided in case you wish to contact any one of the authors of Dynare directly. We nonetheless encourage you to first use the \href{http://www.cepremap.cnrs.fr/juillard/mambo/index.php?option=com_forum&Itemid=95}{Dynare forums} to ask your questions so that other users can benefit from them as well; remember, almost no question is specific enough to interest just one person, and yours is not the exception!
The email addresses above are provided in case you wish to contact any one of the authors of Dynare directly. We nonetheless encourage you to first use the \href{http://www.dynare.org/phpBB3}{Dynare forums} to ask your questions so that other users can benefit from them as well; remember, almost no question is specific enough to interest just one person, and yours is not the exception!
\mainmatter

View File

@ -8,14 +8,14 @@ This User Guide will exclusively \textbf{focus on the Matlab version of Dynare}.
You may also be interested by another version of Dynare, developed in parallel: \textbf{Dynare++}. This is a standalone C++ version of Dynare specialized in computing k-order approximations of dynamic stochastic general equilibrium models. See the \href{http://www.cepremap.cnrs.fr/juillard/mambo/index.php?option=com_content&task=view&id=53&Itemid=86}{Dynare++ webpage} for more information.
\section{System requirements}
Dynare can run on Windows, as well as Unix-like operating systems, such as any Linux distribution, Solaris and, of course, Mac OS X. If you have questions about the support of a particular platform, feel free to write directly to Michel Juillard (michel.juillard"AT"ens.fr) or visit the \href{http://www.cepremap.cnrs.fr/juillard/mambo/index.php?option=com_forum&Itemid=95&page=viewforum&f=1}{\textbf{Dynare forums}}. \\
Dynare can run on Windows, as well as Unix-like operating systems, such as any Linux distribution, Solaris and, of course, Mac OS X. If you have questions about the support of a particular platform, feel free to write directly to Michel Juillard (michel.juillard"AT"ens.fr) or visit the \href{http://www.dynare.org/phpBB3}{\textbf{Dynare forums}}. \\
To run Dynare, it is recommended to allocate at least 256MB of RAM to the platform running Dynare, although 512MB is preferred. Depending on the type of computations required, like the very processor intensive Metropolis Hastings algorithm, you may need up to 1GB of RAM to obtain acceptable computational times. \\
\section{Installing Dynare}
\subsection{Installing on Windows}
The following assumes you have Matlab version 6.5.1 or later installed on your Windows system.\footnote{As of writing this Guide, Dynare is being developed on Matlab version 7. Nonetheless, great care is taken not to introduce features that would not work with reasonably recent versions of Matlab. However, Dynare requires at least the Matlab feature set of version 6.5.1, released September 22, 2003.} ** The current way to install Dynare version 4 may not yet be on par with the procedure described below. If a discrepancy exists, please follow downloading and installation instructions on the Dynare website. \begin{enumerate}
\item Download the latest stable version of Dynare for Matlab (Windows) from the \href{http://www.cepremap.cnrs.fr/juillard/mambo/index.php?option=com_frontpage&Itemid=1}{Dynare website}.
\item Download the latest stable version of Dynare for Matlab (Windows) from the \href{http://www.dynare.org}{Dynare website}.
\item You will now have on your computer a .zip file which you should unzip. This will create a folder called, by default, Dynare and its version number, for example: Dynare\_v4.x (where $x$ stands for any subsequent upgrades).
\item This directory contains several sub-directories, among which (i) matlab, (ii) doc and (iii) examples.
\item Place the Dynare folder (Dynare\_v4.x in our example) in the c: directory and note that location. The easiest is probably to put it in the root of c: as in c:/dynare\_v4.x.
@ -28,6 +28,6 @@ c:/dynare\_v4.x/matlab
\section{Matlab particularities}
A question often comes up: what special Matlab toolboxes are necessary to run Dynare? In fact, no additional toolbox is necessary for running most of Dynare, except maybe for optimal simple rules (see chapter \ref{ch:ramsey}), but even then remedies exist (see the \href{http://www.cepremap.cnrs.fr/juillard/mambo/index.php?option=com_forum&Itemid=95}{Dynare forums} for discussions on this, or to ask your particular question). But if you do have the `optimization toolbox' installed, you will have additional options for solving for the steady state (solve\_algo option) and for searching for the posterior mode (mode\_compute option), both of which are defined later.
A question often comes up: what special Matlab toolboxes are necessary to run Dynare? In fact, no additional toolbox is necessary for running most of Dynare, except maybe for optimal simple rules (see chapter \ref{ch:ramsey}), but even then remedies exist (see the \href{http://www.dynare.org/phpBB3}{Dynare forums} for discussions on this, or to ask your particular question). But if you do have the `optimization toolbox' installed, you will have additional options for solving for the steady state (solve\_algo option) and for searching for the posterior mode (mode\_compute option), both of which are defined later.

View File

@ -1,34 +0,0 @@
This is pdfeTeX, Version 3.141592-1.30.4-2.2 (Web2C 7.5.5) (format=pdflatex 2006.12.1) 16 FEB 2007 18:52
entering extended mode
\write18 enabled.
**ch-intro.tex
(./ch-intro.tex
LaTeX2e <2003/12/01>
Babel <v3.8d> and hyphenation patterns for american, french, german, ngerman, b
ahasa, basque, bulgarian, catalan, croatian, czech, danish, dutch, esperanto, e
stonian, finnish, greek, icelandic, irish, italian, latin, magyar, norsk, polis
h, portuges, romanian, russian, serbian, slovak, slovene, spanish, swedish, tur
kish, ukrainian, nohyphenation, loaded.
! Undefined control sequence.
l.1 \chapter
*{Introduction} \label{ch:intro}
?
! Emergency stop.
l.1 \chapter
*{Introduction} \label{ch:intro}
End of file on the terminal!
Here is how much of TeX's memory you used:
5 strings out of 94424
127 string characters out of 1172363
2048354 words of memory out of 4500000
3314 multiletter control sequences out of 10000+50000
3640 words of font info for 14 fonts, out of 2000000 for 2000
582 hyphenation exceptions out of 5000
5i,0n,1p,55b,8s stack positions out of 5000i,500n,6000p,200000b,40000s
PDF statistics:
0 PDF objects out of 300000
0 named destinations out of 131072
1 words of extra memory for PDF output out of 10000
No pages of output.

View File

@ -53,7 +53,7 @@ While this User Guide tries to be as complete and thorough as possible, you will
\item \href{http://www.cepremap.cnrs.fr/juillard/mambo/download/manual/index.html}{\textbf{Reference Manual}}: this manual covers all Dynare commands, giving a clear definition and explanation of usage for each. The User Guide will often introduce you to a command in a rather loose manner (mainly through examples); so reading corresponding command descriptions in the Reference Manual is a good idea to cover all relevant details.
\item \href{http://www.cepremap.cnrs.fr/juillard/mambo/index.php?option=com_content&task=category&sectionid=11&id=96&Itemid=89}{\textbf{Official online examples}}: the Dynare website includes other examples - usually well documented - of .mod files covering models and methodologies introduced in recent papers.
\item \href{http://www.cepremap.cnrs.fr/juillard/mambo/index.php?option=com_forum&Itemid=95&page=viewforum&f=2&sid=10290a11eb7a48243971159f5b86f83e}{\textbf{Open online examples}}: this page lists .mod files posted by users covering a wide variety of examples.
\item \href{http://www.cepremap.cnrs.fr/juillard/mambo/index.php?option=com_forum&Itemid=95&page=viewforum&f=1}{\textbf{Dynare forums}}: this lively online discussion forum allows you to ask your questions openly and read threads from others who might have run into similar difficulties.
\item \href{http://www.dynare.org/phpBB3}{\textbf{Dynare forums}}: this lively online discussion forum allows you to ask your questions openly and read threads from others who might have run into similar difficulties.
\item \href{http://www.cepremap.cnrs.fr/juillard/mambo/index.php?option=com_content&task=section&id=3&Itemid=40}{\textbf{Frequently Asked Questions}} (FAQ): this section of the Dynare site emphasizes a few of the most popular questions in the forums.
\item \href{http://www.dsge.net}{\textbf{DSGE.net}}: this website, run my members of the Dynare team, is a resource for all scholars working in the field of DSGE modeling. Besides allowing you to stay up to date with the most recent papers and possibly make new contacts, it conveniently lists conferences, workshops and seminars that may be of interest.
\end{itemize}

View File

@ -69,7 +69,7 @@ Section
File ..\mex\octave\rcond.m ..\mex\octave\*.mex
SetOutPath $INSTDIR\doc
File ..\doc\manual.pdf ..\doc\guide.pdf ..\doc\userguide\DynareUserGuide_PublicBeta20081218.pdf ..\doc\bvar-a-la-sims.pdf ..\doc\macroprocessor\macroprocessor.pdf ..\doc\preprocessor\preprocessor.pdf
File ..\doc\manual.pdf ..\doc\guide.pdf ..\doc\userguide\UserGuide.pdf ..\doc\bvar-a-la-sims.pdf ..\doc\macroprocessor\macroprocessor.pdf ..\doc\preprocessor\preprocessor.pdf
SetOutPath $INSTDIR\doc\manual-html
File ..\doc\manual-html\*.html