diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 8581d63..22b9267 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -32,10 +32,12 @@ An small-scale nonlinear New Keynesian model with ZLB is provided `as an example The impulse responses are the usual dynamics of a nonlinear DSGE. -The `yaml files `_ follow a simple structure: +The folder `yaml files `_ also contains a medium scale New Keynesian DSGE model as an example file (`med_scale_nk.yaml`). It can be imported with `from econpizza import example_dsge`. + +The yaml files in the folder follow a simple structure: 1. define all variables and shocks -2. provide the nonlinear equations. Note that the dash at the beginning of each line is *not* a minus! +2. provide the nonlinear equations. Note that each line starts with a `~`. 3. provide the parameters and values. 4. optionally provide some steady state values and/or values for initial guesses 5. optionally provide some auxilliary equations that are not directly part of the nonlinear system (see the `yaml for the BH model `_) diff --git a/econpizza/__init__.py b/econpizza/__init__.py index 99f0d3d..0e2a588 100644 --- a/econpizza/__init__.py +++ b/econpizza/__init__.py @@ -19,3 +19,4 @@ example_nk = os.path.join(pth, "examples", "nk.yaml") example_bh = os.path.join(pth, "examples", "bh.yaml") +example_dsge = os.path.join(pth, "examples", "med_scale_nk.yaml")