From 46dd6690ab323975c1fa650c43e88ce9999cec16 Mon Sep 17 00:00:00 2001 From: Gregor Boehl Date: Fri, 15 Mar 2024 14:07:32 +0100 Subject: [PATCH] provide example yamls --- docs/guide/the_yaml.rst | 3 ++- docs/tutorial/quickstart.ipynb | 6 +++--- docs/tutorial/rank.ipynb | 6 +++--- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/guide/the_yaml.rst b/docs/guide/the_yaml.rst index 0af98f0..2c8be87 100644 --- a/docs/guide/the_yaml.rst +++ b/docs/guide/the_yaml.rst @@ -23,7 +23,8 @@ The YAML files follow a simple structure: 4. optionally provide auxiliary equations that are not directly part of the nonlinear system 5. optionally provide initial guesses for all other steady state values and parameters -I will first briefly discuss the YAML of the small scale *representative* agents NK model `from the quickstart tutorial <../tutorial/quickstart.ipynb>`_ and then turn to a more complex HANK model. +I will first briefly discuss `the YAML `_ of the small scale *representative* agents NK model `from the quickstart tutorial <../tutorial/quickstart.ipynb>`_ and then turn to a more complex HANK model. +A collection of examples is provided `with the package `_. YAML: representative agent models ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/tutorial/quickstart.ipynb b/docs/tutorial/quickstart.ipynb index 907ecb7..af6b5b5 100644 --- a/docs/tutorial/quickstart.ipynb +++ b/docs/tutorial/quickstart.ipynb @@ -11,7 +11,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Take a small-scale nonlinear New Keynesian model with ZLB as a starting point, which is provided [as an example](https://github.com/gboehl/econpizza/blob/master/econpizza/examples/nk.yml). Here is how to simulate it and plot nonlinear impulse responses. Start with some misc imports and load the package:" + "Take a small-scale nonlinear New Keynesian model with ZLB as a starting point, which is provided as an example [(find the yaml file here)](https://github.com/gboehl/econpizza/blob/master/econpizza/examples/nk.yml). Here is how to simulate it and plot nonlinear impulse responses. Start with some misc imports and load the package:" ] }, { @@ -224,9 +224,9 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.10" + "version": "3.11.7" } }, "nbformat": 4, - "nbformat_minor": 2 + "nbformat_minor": 4 } diff --git a/docs/tutorial/rank.ipynb b/docs/tutorial/rank.ipynb index 28f4ace..ade4ac2 100644 --- a/docs/tutorial/rank.ipynb +++ b/docs/tutorial/rank.ipynb @@ -11,7 +11,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Let us dive a bit deeper into the functionalities of the package by looking at a nonlinear medium scale DSGE model in the style of Smets & Wouters (2003,2007). The model features Rothemberg instead of Calvo pricing, the zero-lower bound on the nominal interest rate, and downwards nominal wage rigidity. The full model specification can be found in the appendix of the [original paper](https://gregorboehl.com/live/hank_speed_boehl.pdf)." + "Let us dive a bit deeper into the functionalities of the package by looking at a nonlinear medium scale DSGE model in the style of Smets & Wouters (2003,2007). The model features Rothemberg instead of Calvo pricing, the zero-lower bound on the nominal interest rate, and downwards nominal wage rigidity. The full model specification can be found in the appendix of the [original paper](https://gregorboehl.com/live/hank_speed_boehl.pdf), whereas the [yaml file can be found here](https://github.com/gboehl/econpizza/blob/master/econpizza/examples/dsge.yml)." ] }, { @@ -507,9 +507,9 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.10.10" + "version": "3.11.7" } }, "nbformat": 4, - "nbformat_minor": 2 + "nbformat_minor": 4 }