README.md 1.42 KB
Newer Older
Houtan Bastani's avatar
Houtan Bastani committed
1 2 3
# Dynare Reporting

Originally designed to provide reporting functionality for
Houtan Bastani's avatar
Houtan Bastani committed
4 5 6
[Dynare](https://www.dynare.org), it has been moved to its own repository in the
hopes that it can be used without obliging the user to download Dynare in its
entirety.
Houtan Bastani's avatar
Houtan Bastani committed
7 8 9

# License

Houtan Bastani's avatar
Houtan Bastani committed
10 11
Dynare Reporting is covered by the GNU General Public Licence version 3 or
later (see [LICENSE.md](LICENSE.md) in the Dynare Reporting distribution for
Houtan Bastani's avatar
Houtan Bastani committed
12 13 14 15 16
specifics).

# Obtain the code that Dynare Reporting depends on

Dynare ```reporting``` depends on the Dynare
Houtan Bastani's avatar
Houtan Bastani committed
17
[```dseries```](https://git.dynare.org/Dynare/dseries) repository and on
18
utility functions from the [```dynare```](https://git.dynare.org/Dynare/dynare)
Houtan Bastani's avatar
Houtan Bastani committed
19
repository, located in ```dynare/matlab/utilities/general```
Houtan Bastani's avatar
Houtan Bastani committed
20 21 22

# Use the Dynare Reporting code

Houtan Bastani's avatar
Houtan Bastani committed
23
- Open MATLAB/Octave
Houtan Bastani's avatar
Houtan Bastani committed
24
- Change into the ```reporting``` directory
Houtan Bastani's avatar
Houtan Bastani committed
25 26 27 28 29
- Ensure that the [```dseries```](https://git.dynare.org/Dynare/dseries)
  directory is in your path and initialized correctly (follow the directions on
  the repository site)
- Add ```<<dynare>>/matlab/utilities/general``` to your path where
  ```<<dynare>>``` refers to the base of your Dynare installation
Houtan Bastani's avatar
Houtan Bastani committed
30 31 32 33 34 35
- Run ```initialize_reporting_toolbox```
- Use the reporting code as outlined in the Dynare documentation

# Run the example code

- Follow the steps above
Houtan Bastani's avatar
Houtan Bastani committed
36 37 38
- Change into the ```reporting/test``` directory
- Modify the paths in ```reporting/test/runtest.m``` appropriately
- Run the ```runtest``` matlab script