Commit 53dd93db authored by Houtan Bastani's avatar Houtan Bastani

update resources page

parent 6f16cfd9
......@@ -14,6 +14,9 @@
# remote_theme : "mmistakes/minimal-mistakes"
minimal_mistakes_skin : "contrast" # "default" # "air", "aqua", "contrast", "dark", "dirt", "neon", "mint", "plum", "sunrise"
dynare_stable_version : "4.5.6"
# Site Settings
locale : "en-US"
title : "Dynare"
......
......@@ -3,19 +3,6 @@ title: Resources
---
<br />
# <i class="fas fa-book"></i> Manual
The Dynare Manual is the best place to go to understand the Dynare syntax,
commands, and options. The `.pdf` and `.html` versions of the manual are
distributed with each Dynare release and also available here:
<p class="indent" markdown="1">
<i class="fas fa-file"></i> [HTML Manual](http://www.dynare.org/manual/)
</p>
<p class="indent" markdown="1">
<i class="fas fa-file-download"></i> [PDF Manual](http://www.dynare.org/documentation-and-support/manual/pdf-version/at_download/file)
</p>
# <i class="fab fa-discourse"></i> Forum
If you run into problems with Dynare that you can't seem to resolve by looking
......@@ -34,8 +21,55 @@ how to use Dynare. The fee for students is minimal (equal to expenses on
lunches and one dinner) so as to encourage participation. If this interests
you, please keep a look out for the opening of the application period in April.
# <i class="fas fa-tachometer-alt"></i> Quick Start
For those who want to quickly have something running, the [Quick Start
page](quick_start) explains how to setup Dynare on Windows and to run your
first model file.
# <i class="fas fa-book"></i> Manual
The Dynare Manual is the best place to go to understand the Dynare syntax,
commands, and options. The `.pdf` and `.html` versions of the manual are
distributed with each Dynare release and also available here:
<p class="indent" markdown="1">
<i class="fas fa-file"></i> [HTML Manual](http://www.dynare.org/manual/)
</p>
<p class="indent" markdown="1">
<i class="fas fa-file-download"></i> [PDF Manual](http://www.dynare.org/documentation-and-support/manual/pdf-version/at_download/file)
</p>
# <i class="fas fa-book"></i> User Guide
An in-depth introduction to Dynare, by Tommaso Mancini Griffoli. NB: This document is out of date.
<p class="indent" markdown="1">
<i class="fas fa-file-download"></i> [User Guide](http://www.dynare.org/documentation-and-support/user-guide/Dynare-UserGuide-WebBeta.pdf/at_download/file)
</p>
<p class="indent" markdown="1">
<i class="fas fa-file-archive"></i> [Examples used in user guide](http://www.dynare.org/documentation-and-support/user-guide/models.zip/at_download/file)
</p>
<p class="indent" markdown="1">
<i class="fas fa-external-link-alt"></i> [Errata, additional material, comments](http://www.dynare.org/DynareWiki/UserGuide)
</p>
# <i class="fas fa-glasses"></i> Tutorial
Learn how to perform a stochastic simulation of a small model with Dynare in ten minutes!
<p class="indent" markdown="1">
<i class="fas fa-file-download"></i> [Tutorial](http://www.dynare.org/documentation-and-support/tutorial/guide.pdf/at_download/file)
</p>
<p class="indent" markdown="1">
<i class="fas fa-file-download"></i> [example1.mod](http://www.dynare.org/documentation-and-support/tutorial/example1.mod/at_download/file)
</p>
<p class="indent" markdown="1">
<i class="fas fa-file-download"></i> [example2.mod](http://www.dynare.org/documentation-and-support/tutorial/example2.mod/at_download/file)
</p>
# <i class="fab fa-wikipedia-w"></i> Wiki
Various bits of information such as [new](https://git.dynare.org/Dynare/dynare/wikis/NewFeatures) or undocumented features, [development plans](https://git.dynare.org/Dynare/dynare/wikis/RoadMap), and [known](https://git.dynare.org/Dynare/dynare/wikis/KnownBugs) and [fixed](https://git.dynare.org/Dynare/dynare/wikis/FixedBugs) bugs.
<p class="indent" markdown="1">
<i class="fas fa-external-link-alt"></i> [New Wiki](https://git.dynare.org/Dynare/dynare/wikis/home)
</p>
<p class="indent" markdown="1">
<i class="fas fa-external-link-alt"></i> [Wiki](http://www.dynare.org/DynareWiki/TableOfContents)
<i class="fas fa-external-link-alt"></i> [Old Wiki](http://www.dynare.org/DynareWiki/TableOfContents)
</p>
---
title: Quick Start
---
<br />
For those who want to quickly have something running, this page explains how to
setup Dynare on [Windows](#windows) or [macOS](#macos) and to run your first
model (`.mod`) file.
To run Dynare, you have the choice between running it on MathWorks MATLAB
(proprietary) or GNU Octave (free software).
# Windows
## Using Dynare with MATLAB
1. Make sure that MATLAB is installed on your computer.
1. Download and install the [latest Dynare package](/download#stable)
1. Open MATLAB
1. Configure MATLAB for Dynare (see [the section below](#configuring-matlab-for-dynare-on-windows))
1. Run a Dynare example in MATLAB (see [the section below](#running-and-editing-a-dynare-example-on-windows))
## Using Dynare with Octave
1. Download and install the <i class="fas fa-external-link-alt"></i> [Octave installer](https://www.gnu.org/software/octave/download.html)
1. Download and install the [latest Dynare package](/download#stable)
1. Open Octave
1. Configure Octave for Dynare (see [the section below](#configuring-octave-for-dynare-on-windows))
1. Run a Dynare example in Octave (see [the section below](#running-and-editing-a-dynare-example-on-windows))
## Configuring MATLAB for Dynare on Windows
You have two choices. You can either use the [command window](#1-configuring-matlab-using-the-command-window-on-windows) or the [menu entries](#2-configuring-matlab-using-the-menu-entries-on-windows).
### 1. Configuring MATLAB using the Command Window on Windows
You will have to do this every time you start MATLAB, as MATLAB will not remember the setting.
1. Click on the "Command Window"
1. If you have Dynare installed in the standard location, type the following, replacing `4.x.y` with your Dynare version:
```
>> addpath C:\dynare\4.x.y\matlab
```
For example, for Dynare {{ site.dynare_stable_version }} type:
```
>> addpath C:\dynare\{{ site.dynare_stable_version }}\matlab
```
### 2. Configuring MATLAB using the menu entries on Windows
You will only have to do this once as MATLAB will remember the setting the next time you run it.
1. On the MATLAB `Home` tab, in the `Environment` section, click on `Set Path`
1. Click `Add Folder...`. <i class="fas fa-exclamation-triangle"></i> **Warning: DO NOT** select `Add with Subfolders...`
1. Select the `matlab` subdirectory of your Dynare installation. For example, if you have installed Dynare {{ site.dynare_stable_version }} in the standard location, select:
```
C:\dynare\{{ site.dynare_stable_version }}\matlab
```
1. Apply the setting by clicking `Save` button
## Configuring Octave for Dynare on Windows
If you have Dynare installed in the standard location type the following at the Octave command prompt, replacing `4.x.y` with your Dynare version:
Windows
```
>> addpath C:\dynare\4.x.y\matlab
```
For example, for Dynare {{ site.dynare_stable_version }} type:
```
>> addpath C:\dynare\{{ site.dynare_stable_version }}\matlab
```
If you don't want to type this command every time you run Octave, you can put it in a file called `.octaverc` in your home directory. This file will usually be called `C:\Documents and Settings\USERNAME\.octaverc` on Windows XP and `C:\Users\USERNAME\.octaverc` on Windows Vista/7.
## Running and editing a Dynare example on Windows
1. Create a working directory that will hold your Dynare models. For example, `C:\dynare\work`.
1. Assuming that you are using Dynare {{ site.dynare_stable_version }}, copy the example model file `C:\dynare\{{ site.dynare_stable_version }}\examples\example1.mod` to your working directory.
1. At the MATLAB or Octave command prompt, type the following to change the working directory:
```
>> cd C:\dynare\work
```
1. Then type the following to run the example model file:
```
>> dynare example1
```
1. You can edit the example by typing:
```
>> edit example1.mod
```
<br />
# macOS
## Using Dynare with MATLAB
1. Make sure that MATLAB is installed on your computer.
1. Download and install the [latest Dynare package](/download#stable)
1. Open MATLAB
1. Configure MATLAB for Dynare (see [the section below](#configuring-matlab-for-dynare-on-macos))
1. Run a Dynare example in MATLAB (see [the section below](#running-and-editing-a-dynare-example-on-macos))
## Using Dynare with Octave
1. Download and install [Homebrew](https://brew.sh/) following the instructions on their site
1. Install Octave and Dynare via Homebrew
1. Open Terminal (`Applications->Utilities->Terminal`)
1. At the terminal prompt, type:
```
brew update && brew upgrade && brew install dynare
```
1. Open Octave
1. Open Terminal (`Applications->Utilities->Terminal`)
1. At the terminal prompt, type:
```
octave
```
1. Configure Octave for Dynare (see [the section below](#configuring-octave-for-dynare-on-macos))
1. Run a Dynare example in Octave (see [the section below](#running-and-editing-a-dynare-example-on-macos))
## Configuring MATLAB for Dynare on macOS
You have two choices. You can either use the [command window](#1-configuring-matlab-using-the-command-window-on-macos) or the [menu entries](#2-configuring-matlab-using-the-menu-entries-on-macos).
### 1. Configuring MATLAB using the Command Window on macOS
You will have to do this every time you start MATLAB, as MATLAB will not remember the setting.
1. Click on the "Command Window"
1. If you have Dynare installed in the standard location, type the following, replacing `4.x.y` with your Dynare version:
```
>> addpath /Applications/Dynare/4.x.y/matlab
```
For example, for Dynare {{ site.dynare_stable_version }} type:
```
>> addpath /Applications/Dynare/{{ site.dynare_stable_version }}/matlab
```
### 2. Configuring MATLAB using the menu entries on macOS
You will only have to do this once as MATLAB will remember the setting the next time you run it.
1. On the MATLAB `Home` tab, in the `Environment` section, click on `Set Path`
1. Click `Add Folder...`. <i class="fas fa-exclamation-triangle"></i> **Warning: DO NOT** select `Add with Subfolders...`
1. Select the `matlab` subdirectory of your Dynare installation. For example, if you have installed Dynare {{ site.dynare_stable_version }} in the standard location, select:
```
/Applications/Dynare/{{ site.dynare_stable_version }}/matlab
```
1. Apply the setting by clicking `Save` button
## Configuring Octave for Dynare on macOS
If you have Dynare installed in the standard location type the following at the Octave command prompt, replacing `4.x.y` with your Dynare version:
```
>> addpath /Applications/Dynare/4.x.y/matlab
```
For example, for Dynare {{ site.dynare_stable_version }} type:
```
>> addpath /Applications/Dynare/{{ site.dynare_stable_version }}/matlab
```
If you don't want to type this command every time you run Octave, you can put
it in a file called `.octaverc` in your home directory. This file will usually
be called `/home/USERNAME/.octaverc`.
## Running and editing a Dynare example on macOS
1. Create a working directory that will hold your Dynare models. For example, `/home/USERNAME/work`.
1. Assuming that you are using Dynare {{ site.dynare_stable_version }}, copy the example model file `/Applications/Dynare/{{ site.dynare_stable_version }}/examples/example1.mod` to your working directory.
1. At the MATLAB or Octave command prompt, type the following to change the working directory:
```
>> cd /home/USERNAME/work
```
1. Then type the following to run the example model file:
```
>> dynare example1
```
1. You can edit the example by typing:
```
>> edit example1.mod
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment