Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found
Select Git revision

Target

Select target project
  • giovanma/dynare
  • giorgiomas/dynare
  • Vermandel/dynare
  • Dynare/dynare
  • normann/dynare
  • MichelJuillard/dynare
  • wmutschl/dynare
  • FerhatMihoubi/dynare
  • sebastien/dynare
  • lnsongxf/dynare
  • rattoma/dynare
  • CIMERS/dynare
  • FredericKarame/dynare
  • SumuduK/dynare
  • MinjeJeon/dynare
  • camilomrch/dynare
  • DoraK/dynare
  • avtishin/dynare
  • selma/dynare
  • claudio_olguin/dynare
  • jeffjiang07/dynare
  • EthanSystem/dynare
  • stepan-a/dynare
  • wjgatt/dynare
  • JohannesPfeifer/dynare
  • gboehl/dynare
  • chskcau/dynare-doc-fixes
27 results
Select Git revision
Show changes
Commits on Source (13)
Show whitespace changes
Inline Side-by-side
Showing
with 1506 additions and 0 deletions
.gitignore
View file @ 79d38099
...@@ -92,6 +92,7 @@ ar-lib ...@@ -92,6 +92,7 @@ ar-lib
doc/m2html doc/m2html
doc/internals/*.html doc/internals/*.html
doc/internals/ltxpng doc/internals/ltxpng
doc/manual/build
mex/build/matlab/run_m2html.m mex/build/matlab/run_m2html.m
# Preprocessor # Preprocessor
......
doc/manual/Makefile 0 → 100644
View file @ 79d38099
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Dynaremanual.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Dynaremanual.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Dynaremanual"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Dynaremanual"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
doc/manual/make.bat 0 → 100644
View file @ 79d38099
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
set I18NSPHINXOPTS=%SPHINXOPTS% source
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. texinfo to make Texinfo files
echo. gettext to make PO message catalogs
echo. changes to make an overview over all changed/added/deprecated items
echo. xml to make Docutils-native XML files
echo. pseudoxml to make pseudoxml-XML files for display purposes
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
%SPHINXBUILD% 2> nul
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Dynaremanual.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Dynaremanual.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
if errorlevel 1 exit /b 1
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
if errorlevel 1 exit /b 1
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdf" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "latexpdfja" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
cd %BUILDDIR%/latex
make all-pdf-ja
cd %BUILDDIR%/..
echo.
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "texinfo" (
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
goto end
)
if "%1" == "gettext" (
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
if errorlevel 1 exit /b 1
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
if errorlevel 1 exit /b 1
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
if errorlevel 1 exit /b 1
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
if "%1" == "xml" (
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The XML files are in %BUILDDIR%/xml.
goto end
)
if "%1" == "pseudoxml" (
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
if errorlevel 1 exit /b 1
echo.
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
goto end
)
:end
doc/manual/source/bibliography.rst 0 → 100644
View file @ 79d38099
.. _bibliography:
**************
Bibliography
**************
doc/manual/source/conf.py 0 → 100644
View file @ 79d38099
# -*- coding: utf-8 -*-
#
# Dynare manual documentation build configuration file, created by
# sphinx-quickstart on Tue Jul 29 12:46:44 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
import sphinx_rtd_theme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Dynare'
copyright = u'2014, Stéphane Adjemian'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '4.5'
# The full version, including alpha/beta/rc tags.
release = '4.5-pre'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "sphinx_rtd_theme" #'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] #[]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'Dynaremanualdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'Dynaremanual.tex', u'Dynare manual Documentation',
u'Stéphane Adjemian', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'dynaremanual', u'Dynare manual Documentation',
[u'Stéphane Adjemian'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'Dynare', u'Dynare Documentation',
u'Stéphane Adjemian', 'Dynare', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = u'Dynare manual'
epub_author = u'Stéphane Adjemian'
epub_publisher = u'Stéphane Adjemian'
epub_copyright = u'2014, Stéphane Adjemian'
# The basename for the epub file. It defaults to the project name.
#epub_basename = u'Dynare manual'
# The HTML theme for the epub output. Since the default themes are not optimized
# for small screen space, using the same theme for HTML and epub output is
# usually not wise. This defaults to 'epub', a theme designed to save visual
# space.
#epub_theme = 'epub'
# The language of the text. It defaults to the language option
# or en if the language is not set.
#epub_language = ''
# The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#epub_identifier = ''
# A unique identification for the text.
#epub_uid = ''
# A tuple containing the cover image and cover page html template filenames.
#epub_cover = ()
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
#epub_guide = ()
# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_pre_files = []
# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
#epub_post_files = []
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# The depth of the table of contents in toc.ncx.
#epub_tocdepth = 3
# Allow duplicate toc entries.
#epub_tocdup = True
# Choose between 'default' and 'includehidden'.
#epub_tocscope = 'default'
# Fix unsupported image types using the PIL.
#epub_fix_images = False
# Scale large images.
#epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#epub_show_urls = 'inline'
# If false, no index is generated.
#epub_use_index = True
doc/manual/source/examples.rst 0 → 100644
View file @ 79d38099
.. _examples:
**********
Examples
**********
doc/manual/source/index.rst 0 → 100644
View file @ 79d38099
.. Dynare reference manual master file
Dynare's Reference manual
=========================
.. toctree::
:maxdepth: 1
introduction
installation-and-configuration
running-dynare
the-model-file
the-configuration-file
time-series
reporting
examples
misc-commands
bibliography
This is Dynare Reference Manual, version 4.5-unstable.
Copyright © 1996-2014, Dynare Team.
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.
A copy of the license can be found at http://www.gnu.org/licenses/fdl.txt.
doc/manual/source/installation-and-configuration.rst 0 → 100644
View file @ 79d38099
.. _installation-and-introduction:
********************************
Installation and configuration
********************************
.. contents::
:local:
:depth: 2
.. installation_soft-requirements:
Software requirements
---------------------
Packaged versions of Dynare are available for Windows XP/Vista/7/8,
`Debian GNU/Linux`_, `Ubuntu`_ and Mac OS X Leopard/Snow Leopard. Dynare
should work on other systems, but some compilation steps are necessary
in that case.
In order to run Dynare, you need one of the following:
* `MATLAB`_ version 7.5 (R2007b) or above;
* `GNU Octave`_ version 3.6 or above.
Packages of GNU Octave can be downloaded on the `Dynare website`_.
The following optional extensions are also useful to benefit from
extra features, but are in no way required:
* If under MATLAB: the optimization toolbox, the statistics toolbox,
the control system toolbox;
* If under GNU Octave, the following `Octave-Forge`_ packages: optim,
io, java, statistics, control.
If you plan to use the ``use_dll`` option of the model command,
you will need to install the necessary requirements for compiling MEX
files on your machine. If you are using MATLAB under Windows, install
a C++ compiler on your machine and configure it with MATLAB: see
instructions on the `Dynare wiki`_. Users of Octave under Linux should
install the package for MEX file compilation (under Debian or Ubuntu,
it is called ‘liboctave-dev’). If you are using Octave or MATLAB under
Mac OS X, you should install the latest version of XCode: see
instructions on the Dynare wiki. Mac OS X Octave users will also need
to install gnuplot if they want graphing capabilities. Users of MATLAB
under Linux and Mac OS X, and users of Octave under Windows, normally
need to do nothing, since a working compilation environment is
available by default.
.. installation_install:
Installation of Dynare
----------------------
.. installation_install_windows:
On Windows
^^^^^^^^^^
Execute the automated installer called dynare-4.x.y-win.exe (where
4.x.y is the version number), and follow the instructions. The default
installation directory is c:\\dynare\\4.x.y. After installation, this
directory will contain several sub-directories, among which are
‘matlab’, ‘mex’ and ‘doc’. The installer will also add an entry in
your Start Menu with a shortcut to the documentation files and
uninstaller.
Note that you can have several versions of Dynare coexisting (for
example in ‘c:\\dynare’), as long as you correctly adjust your path
settings (see section Some words of warning).
.. installation_install_linux:
On Debian GNU/Linux and Ubuntu
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Please refer to the `Dynare wiki`_ for detailed instructions. Dynare
will be installed under ‘/usr/share/dynare’ and
‘/usr/lib/dynare’. Documentation will be under
‘/usr/share/doc/dynare’.
.. installation_install_macos:
On Mac OS X
^^^^^^^^^^^
Execute the automated installer called ‘dynare-4.x.y.pkg’ (where 4.x.y
is the version number), and follow the instructions. The default
installation directory is ‘/Applications/Dynare/4.x.y’.
Please refer to the `Dynare wiki`_ for detailed instructions. After
installation, this directory will contain several sub-directories,
among which are ‘matlab’, ‘mex’ and ‘doc’.
Note that you can have several versions of Dynare coexisting (for
example in ‘/Applications/Dynare’), as long as you correctly adjust
your path settings (see section Some words of warning).
.. installation_config:
Configuration
-------------
.. installation_config_matlab:
For MATLAB
^^^^^^^^^^
You need to add the ‘matlab’ subdirectory of your Dynare installation
to MATLAB path. You have two options for doing that:
* Using the addpath command in the MATLAB command window.
* Under Windows, assuming that you have installed Dynare in the
standard location, and replacing 4.x.y with the correct version
number::
>> addpath c:\dynare\4.x.y\matlab
* Under Debian GNU/Linux or Ubuntu::
>> addpath /usr/share/dynare/matlab
* Under Mac OS X, assuming that you have installed Dynare in the
standard location, and replacing 4.x.y with the correct version
number::
>> addpath /Applications/Dynare/4.x.y/matlab
MATLAB will not remember this setting next time you run it, and you
will have to do it again. The advantage of this option is that it
ensures that Dynare is on top of the MATLAB path.
* Via the menu entries: Select the “Set Path” entry in the “File”
menu, then click on “Add Folder…”, and select the ‘matlab’
subdirectory of your Dynare installation. 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.
.. installation_config_octave:
For GNU Octave
^^^^^^^^^^^^^^
You need to add the ‘matlab’ subdirectory of your Dynare installation
to Octave path, using the addpath at the Octave command prompt.
* Under Windows, assuming that you have installed Dynare in the standard
location, and replacing “4.x.y” with the correct version number::
>> addpath c:\dynare\4.x.y\matlab
* Under Debian GNU/Linux or Ubuntu, there is no need to use the
addpath command; the packaging does it for you.
* Under Mac OS X, assuming that you have installed Dynare in the
standard location, and replacing “4.x.y” with the correct version
number::
>> addpath /Applications/Dynare/4.x.y/matlab
If you do not want to type this command every time you run Octave, you
can put it in a file called ‘.octaverc’ in your home directory (under
Windows this will generally be ‘c:\\Documents and
Settings\\USERNAME\\’ while under Mac OS X it is
‘/Users/USERNAME/’). This file is run by Octave at every startup.
.. installation_config_warnings:
Some words of warning
^^^^^^^^^^^^^^^^^^^^^
You should be very careful about the content of your MATLAB or Octave
path. You can display its content by simply typing ``path`` in the command
window.
The path should normally contain system directories of MATLAB or
Octave, and some subdirectories of your Dynare installation. You have
to manually add the ‘matlab’ subdirectory, and Dynare will
automatically add a few other subdirectories at runtime (depending on
your configuration). You must verify that there is no directory coming
from another version of Dynare than the one you are planning to use.
You have to be aware that adding other directories to your path can
potentially create problems if any of your M-files have the same name
as a Dynare file. Your file would then override the Dynare file,
making Dynare unusable.
.. _Debian GNU/Linux: http://www.debian.org/
.. _Ubuntu: http://www.ubuntu.com/
.. _Dynare website: http://www.dynare.org/download/octave
.. _Octave-Forge: http://octave.sourceforge.net/
.. _GNU Octave: http://www.octave.org/
.. _MATLAB: http://www.mathworks.com/products/matlab/
.. _Dynare wiki: http://www.dynare.org/DynareWiki
doc/manual/source/introduction.rst 0 → 100644
View file @ 79d38099
.. _introduction:
**************
Introduction
**************
.. introduction_what-is_dynare:
What is Dynare
--------------
Dynare is a software platform for handling a wide class of economic
models, in particular dynamic stochastic general equilibrium (DSGE)
and overlapping generations (OLG) models. The models solved by Dynare
include those relying on the rational expectations hypothesis, wherein
agents form their expectations about the future in a way consistent
with the model. But Dynare is also able to handle models where
expectations are formed differently: on one extreme, models where
agents perfectly anticipate the future; on the other extreme, models
where agents have limited rationality or imperfect knowledge of the
state of the economy and, hence, form their expectations through a
learning process. In terms of types of agents, models solved by Dynare
can incorporate consumers, productive firms, governments, monetary
authorities, investors and financial intermediaries. Some degree of
heterogeneity can be achieved by including several distinct classes of
agents in each of the aforementioned agent categories.
Dynare offers a user-friendly and intuitive way of describing these
models. It is able to perform simulations of the model given a
calibration of the model parameters and is also able to estimate these
parameters given a dataset. In practice, the user will write a text
file containing the list of model variables, the dynamic equations
linking these variables together, the computing tasks to be performed
and the desired graphical or numerical outputs.
A large panel of applied mathematics and computer science techniques
are internally employed by Dynare: multivariate nonlinear solving and
optimization, matrix factorizations, local functional approximation,
Kalman filters and smoothers, MCMC techniques for Bayesian estimation,
graph algorithms, optimal control, …
Various public bodies (central banks, ministries of economy and
finance, international organisations) and some private financial
institutions use Dynare for performing policy analysis exercises and
as a support tool for forecasting exercises. In the academic world,
Dynare is used for research and teaching purposes in postgraduate
macroeconomics courses.
Dynare is a free software, which means that it can be downloaded free
of charge, that its source code is freely available, and that it can
be used for both non-profit and for-profit purposes. Most of the
source files are covered by the GNU General Public Licence (GPL)
version 3 or later (there are some exceptions to this, see the file
license.txt in Dynare distribution). It is available for the Windows,
Mac and Linux platforms and is fully documented through a user guide
and a reference manual. Part of Dynare is programmed in C++, while the
rest is written using the `MATLAB`_ programming language. The latter
implies that commercially-available `MATLAB`_ software is required in
order to run Dynare. However, as an alternative to `MATLAB`_, Dynare
is also able to run on top of `GNU Octave`_ (basically a free clone of
`MATLAB`_): this possibility is particularly interesting for students
or institutions who cannot afford, or do not want to pay for,
`MATLAB`_ and are willing to bear the concomitant performance loss.
The development of Dynare is mainly done at `Cepremap`_ by a core team
of researchers who devote part of their time to software
development. Currently the development team of Dynare is composed of
Stéphane Adjemian (`Université du Maine`_, Gains), Houtan Bastani
(`Cepremap`_), Michel Juillard (`Banque de France`_), Frédéric Karamé
(`Université du Maine`_, Gains and `Cepremap`_), Junior Maih (Norges
Bank), Ferhat Mihoubi (Université Paris-Est Créteil, Epee and
Cepremap), George Perendia, Johannes Pfeifer (University of Mannheim),
Marco Ratto (JRC) and Sébastien Villemot (`OFCE – Sciences Po`_). Increasingly,
the developer base is expanding, as tools developed by researchers
outside of Cepremap are integrated into Dynare. Financial support is
provided by `Cepremap`_, `Banque de France`_ and `DSGE-net`_ (an
international research network for DSGE modeling). The Dynare project
also received funding through the Seventh Framework Programme for
Research (FP7) of the European Commission’s Socio-economic Sciences
and Humanities (SSH) Program from October 2008 to September 2011 under
grant agreement SSH-CT-2009-225149.
Interaction between developers and users of Dynare is central to the
project. A web forum is available for users who have questions about
the usage of Dynare or who want to report bugs. Training sessions are
given through the Dynare Summer School, which is organized every year
and is attended by about 40 people. Finally, priorities in terms of
future developments and features to be added are decided in
cooperation with the institutions providing financial support.
.. introduction_documentation-sources:
Documentation sources
---------------------
The present document is the reference manual for Dynare. It documents
all commands and features in a systematic fashion. New users may
rather begin with Dynare User Guide (Mancini (2007)), distributed with
Dynare and also available from the official Dynare web site.
Other useful sources of information include the `Dynare wiki`_ and the `Dynare forums`_.
.. introduction_citation:
Citing Dynare in your research
------------------------------
If you would like to refer to Dynare in a research article, the
recommended way is to cite the present manual, as follows:
Stéphane Adjemian, Houtan Bastani, Michel Juillard, Frédéric
Karamé, Ferhat Mihoubi, George Perendia, Johannes Pfeifer, Marco
Ratto and Sébastien Villemot (2011), “*Dynare: Reference Manual,
Version 4*,” Dynare Working Papers, 1, CEPREMAP
Note that citing the Dynare Reference Manual in your research is a
good way to help the Dynare project.
If you want to give a URL, use the address of the Dynare website:
http://www.dynare.org.
.. _Dynare wiki: http://www.dynare.org/DynareWiki
.. _Dynare forums: http://www.dynare.org/phpBB3
.. _GNU Octave: http://www.octave.org/
.. _MATLAB: http://www.mathworks.com/products/matlab/
.. _Cepremap: http://www.cepremap.fr
.. _Université du Maine: http://www.univ-lemans.fr
.. _Banque de France: http://www.banque-france.fr
.. _DSGE-net: http://www.dsge.net
.. _OFCE – Sciences Po: http://www.ofce.fr
doc/manual/source/misc-commands.rst 0 → 100644
View file @ 79d38099
.. _dynare-misc-commands:
***********************
Dynare misc. commands
***********************
doc/manual/source/reporting.rst 0 → 100644
View file @ 79d38099
.. _reporting:
***********
Reporting
***********
doc/manual/source/running-dynare.rst 0 → 100644
View file @ 79d38099
.. _running-dynare:
****************
Running Dynare
****************
^^^^^^^^^^^^^^^^^
Dynare invocation
^^^^^^^^^^^^^^^^^
In order to give instructions to Dynare, the user has to write a model
file whose filename extension must be '.mod'. This file contains the
description of the model and the computing tasks required by the
user. Its contents is described in :ref:`The model file <the-model-file>` section of this reference manual.
Once the model file is written, Dynare is invoked using the ``dynare``
command at the MATLAB or Octave prompt (with the filename of the
'.mod' given as argument).
In practice, the handling of the model file is done in two steps: in
the first one, the model and the processing instructions written by
the user in a model file are interpreted and the proper MATLAB or GNU
Octave instructions are generated; in the second step, the program
actually runs the computations. Both steps are triggered automatically
by the ``dynare`` command.
.. function:: dynare FILENAME[.mod] [OPTIONS…]
**Description**
This command launches Dynare and executes the instructions included
in 'FILENAME.mod'. This user-supplied file contains the model and
the processing instructions, as described in :ref:`The model file
<the-model-file>` section. The ``dynare`` command begins by
launching the preprocessor on the '.mod' file. By default (unless
``use_dll`` or ``bytecode`` options have been given to the
``model`` block), the preprocessor creates three intermediary
files:
* 'FILENAME.m' Contains variable declarations, and computing tasks
* 'FILENAME_dynamic.m' Contains the dynamic model equations. Note
that Dynare might introduce auxiliary equations and variables
(see section Auxiliary variables). Outputs are the residuals of
the dynamic model equations in the order the equations were
declared and the Jacobian of the dynamic model equations. For
higher order approximations also the Hessian and the third-order
derivatives are provided. When computing the Jacobian of the
dynamic model, the order of the endogenous variables in the
columns is stored in ``M_.lead_lag_incidence``. The rows of this
matrix represent time periods: the first row denotes a lagged
(time t-1) variable, the second row a contemporaneous (time t)
variable, and the third row a leaded (time t+1) variable. The
columns of the matrix represent the endogenous variables in their
order of declaration. A zero in the matrix means that this
endogenous does not appear in the model in this time period. The
value in the ``M_.lead_lag_incidence`` matrix corresponds to the
column of that variable in the Jacobian of the dynamic
model. Example: Let the second declared variable be c and the
(3,2) entry of ``M_.lead_lag_incidence`` be 15. Then the 15th
column of the Jacobian is the derivative with respect to y(+1).
* 'FILENAME_static.m' Contains the long run static model
equations. Note that Dynare might introduce auxiliary equations
and variables (see section Auxiliary variables). Outputs are the
residuals of the static model equations in the order the
equations were declared and the Jacobian of the static
equations. Entry (i,j) of the Jacobian represents the derivative
of the ith static model equation with respect to the jth model
variable in declaration order.
These files may be looked at to understand errors reported at the
simulation stage. Dynare will then run the computing tasks by
executing 'FILENAME.m'.
A few words of warning is warranted here: the filename of the
'.mod' file should be chosen in such a way that the generated
'.m' files described above do not conflict with '.m' files
provided by MATLAB/Octave or by Dynare. Not respecting this rule
could cause crashes or unexpected behaviour. In particular, it
means that the '.mod' file cannot be given the name of a
MATLAB/Octave or Dynare command. Under Octave, it also means that
the '.mod' file cannot be named 'test.mod'.
**Options**
* ``noclearall``
By default, dynare will issue a clear all command to MATLAB or
Octave, thereby deleting all workspace variables; this options
instructs dynare not to clear the workspace.
* ``debug``
Instructs the preprocessor to write some debugging information
about the scanning and parsing of the '.mod' file.
* ``notmpterms``
Instructs the preprocessor to omit temporary terms in the static
and dynamic files; this generally decreases performance, but is
used for debugging purposes since it makes the static and dynamic
files more readable.
* ``savemacro`` [=FILENAME]
Instructs dynare to save the intermediary file which is obtained
after macro-processing (see section :ref:`Macro processing
language <the-model-file_macro-processing-language>`); the saved
output will go in the file specified, or if no file is specified
in 'FILENAME-macroexp.mod'
* ``onlymacro``
Instructs the preprocessor to only perform the macro-processing
step, and stop just after. Mainly useful for debugging purposes or
for using the macro-processor independently of the rest of Dynare
toolbox.
* ``nolinemacro``
Instructs the macro-preprocessor to omit line numbering
information in the intermediary '.mod' file created after the
macro-processing step. Useful in conjunction with savemacro when
one wants that to reuse the intermediary '.mod' file, without
having it cluttered by line numbering directives.
* ``nolog``
Instructs Dynare to no create a logfile of this run in
'FILENAME.log'. The default is to create the logfile.
* ``nowarn``
Suppresses all warnings.
* ``warn_uninit``
Display a warning for each variable or parameter which is not
initialized. See section :ref:`Parameter
initialization<the-model-file_parameter-initialization>`, or
``load_params_and_steady_state`` for initialization of
parameters. See section :ref:`Initial and terminal
conditions<the-model-file_initial-and-terminal-conditions>`,
or ``load_params_and_steady_state`` for initialization of
endogenous and exogenous variables.
* ``console``
Activate console mode. In addition to the behavior of
``nodisplay``, Dynare will not use graphical waitbars for long
computations.
* ``nograph``
Activate the nograph option (see nograph), so that Dynare will not produce any graph.
* ``nointeractive``
Instructs Dynare to not request user input.
* ``cygwin``
Tells Dynare that your MATLAB is configured for compiling MEX
files with Cygwin (see section Software requirements). This option
is only available under Windows, and is used in conjunction with
the ``use_dll`` option in the model block.
* ``msvc``
Tells Dynare that your MATLAB is configured for compiling MEX
files with Microsoft Visual C++ (see section Software
requirements). This option is only available under Windows, and is
used in conjunction with the ``use_dll`` option in the model
block.
* ``parallel`` [=CLUSTER_NAME]
Tells Dynare to perform computations in parallel. If CLUSTER_NAME
is passed, Dynare will use the specified cluster to perform
parallel computations. Otherwise, Dynare will use the first
cluster specified in the configuration file. See section :ref:`The
Configuration File<the-configuration-file>`, for more information.
* ``conffile`` =FILENAME
Specifies the location of the configuration file if it differs
from the default. See section :ref:`The Configuration
File<the-configuration-file>`, for more information about the
configuration file and its default location.
* ``parallel_slave_open_mode``
Instructs Dynare to leave the connection to the slave node open
after computation is complete, closing this connection only when
Dynare finishes processing.
* ``parallel_test``
Tests the parallel setup specified in the configuration file
without executing the .mod file. See section :ref:`The
Configuration File<the-configuration-file>`, for more information.
* ``-DMACRO_VARIABLE`` =MACRO_EXPRESSION
Defines a macro-variable from the command line (the same effect as
using the Macro directive ``@#define`` in a model file, see
section :ref:`Macro processing
language<the-model-file_macro-processing-language>`).
* ``nostrict``
Allows Dynare to issue a warning and continue processing when
there are more endogenous variables than equations, an undeclared
symbol is assigned in ``initval`` or ``endval``.
**Output**
Depending on the computing tasks requested in the .mod file, executing
the dynare command will leave variables containing results in the
workspace available for further processing. More details are given under
the relevant computing tasks.
The ``M_``, ``oo_``, and ``options_`` structures are saved in a file called
FILENAME_results.mat. If they exist, ``estim_params_``, ``bayestopt_``, ``dataset_``,
and ``estimation_info`` are saved in the same file.
**Examples**
.. code-block:: none
>> dynare ramst
>> dynare ramst nolog
Dynare will fail to run a .mod file if this file is not in the current
directory. For this example, assuming that Dynare is installed under
'c:\\dynare\\4.x.y' (default Windows path), the ramst.mod is in subfolder
'c:\\dynare\\4.x.y\\examples'. If the command ``pwd`` on Matlab/Octave command
prompt returns a different path, you need to change the current path. This
can be done using the ``cd`` command::
>> cd c:\dynare\4.x.y\examples
The output of Dynare is left into three main variables in the MATLAB/Octave workspace.
* ``M_``, a structure containing various information about the model.
* ``options_``, a structure contains the values of the various options used by Dynare during the computation.
* ``oo_``, a structure containing the various results of the computations.
^^^^^^^^^^^^
Dynare hooks
^^^^^^^^^^^^
It is possible to call pre and post Dynare preprocessor hooks written as MATLAB
scripts. The script 'MODFILENAME/hooks/priorprocessing.m' is executed before the
call to Dynare’s preprocessor, and can be used to programmatically transform
the mod file that will be read by the preprocessor. The script
'MODFILENAME/hooks/postprocessing.m' is executed just after the call to Dynare’s
preprocessor, and can be used to programmatically transform the files generated
by Dynare’s preprocessor before actual computations start. The pre and/or post
dynare preprocessor hooks are executed if and only if the aforementioned
scripts are detected in the same folder as the the model file, 'FILENAME.mod'.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Understanding Preprocessor Error Messages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the preprocessor runs into an error while processing your '.mod' file, it will
issue an error. Due to the way that a parser works, sometimes these errors can
be misleading. Here, we aim to demystify these error messages.
The preprocessor issues error messages of the form:
1. ERROR: <<file.mod>>: line A, col B: <<error message>>
2. ERROR: <<file.mod>>: line A, cols B-C: <<error message>>
3. ERROR: <<file.mod>>: line A, col B - line C, col D: <<error message>>
The first two errors occur on a single line, with error two spanning multiple
columns. Error three spans multiple rows.
Often, the line and column numbers are precise, leading you directly to the
offending syntax. Infrequently however, because of the way the parser works,
this is not the case. The most common example of misleading line and column
numbers (and error message for that matter) is the case of a missing semicolon,
as seen in the following example::
varexo a, b
parameters c, ...;
In this case, the parser doesn’t know a semicolon is missing at the end of the
varexo command until it begins parsing the second line and bumps into the
parameters command. This is because we allow commands to span multiple lines
and, hence, the parser cannot know that the second line will not have a
semicolon on it until it gets there. Once the parser begins parsing the second
line, it realizes that it has encountered a keyword, parameters, which it did
not expect. Hence, it throws an error of the form: ERROR: <<file.mod>>: line 2,
cols 0-9: syntax error, unexpected PARAMETERS. In this case, you would simply
place a semicolon at the end of line one and the parser would continue
processing.
doc/manual/source/the-configuration-file.rst 0 → 100644
View file @ 79d38099
.. _the-configuration-file:
************************
The configuration file
************************
doc/manual/source/the-model-file.rst 0 → 100644
View file @ 79d38099
.. _the-model-file:
****************
The model file
****************
.. toctree::
:maxdepth: 1
the-model-file/conventions
the-model-file/variable-declarations
the-model-file/expressions
the-model-file/parameter-initialization
the-model-file/model-declaration
the-model-file/auxiliary-variables
the-model-file/initial-and-terminal-conditions
the-model-file/shocks-on-exogenous-variables
the-model-file/other-general-declarations
the-model-file/steady-state
the-model-file/getting-informations-about-the-model
the-model-file/deterministic-simulations
the-model-file/stochastic-solution-and-simulation
the-model-file/estimation
the-model-file/forecasting
the-model-file/optimal-policy
the-model-file/sensitivity-and-identification-analysis
the-model-file/markov-switching-sbvar
the-model-file/displaying-and-saving-results
the-model-file/macro-processing-language
the-model-file/verbatim-inclusion
the-model-file/misc-commands
doc/manual/source/the-model-file/auxiliary-variables.rst 0 → 100644
View file @ 79d38099
.. _the-model-file_auxiliary_variables:
Auxiliary variables
-------------------
doc/manual/source/the-model-file/conventions.rst 0 → 100644
View file @ 79d38099
.. _the-model-file_conventions:
Conventions
-----------
doc/manual/source/the-model-file/deterministic-simulations.rst 0 → 100644
View file @ 79d38099
.. _the-model-file_deterministic-simulations:
Deterministic simulations
-------------------------
doc/manual/source/the-model-file/displaying-and-saving-results.rst 0 → 100644
View file @ 79d38099
.. _the-model-file_displaying-and-saving-results:
Displaying and saving results
-----------------------------
doc/manual/source/the-model-file/estimation.rst 0 → 100644
View file @ 79d38099
.. _the-model-file_estimation:
Estimation
----------
doc/manual/source/the-model-file/expressions.rst 0 → 100644
View file @ 79d38099
.. _the-model-file_expressions:
Expressions
-----------