docs: add titles to examples and small fixes

bancaditalia · May 24, 2024 · 44ce320 · 44ce320
1 parent eeaff01
commit 44ce320
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 3 deletions.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -38,8 +38,6 @@ initial_conditions = BeforeIT.AUSTRIA2010Q1.initial_conditions
 T = 20
 model = BeforeIT.initialise_model(parameters, initial_conditions, T)
 data = BeforeIT.run_one_sim!(model)
-
-plot(data.real_gdp)
 ```
 
 To plot the results of the simulation, install the `Plots` package via ```Pkg.add("Plots")```  and then run

diff --git a/examples/basic_example.jl b/examples/basic_example.jl
@@ -1,3 +1,5 @@
+# # Essential use of BeforeIT
+
 # We start by importing the BeforeIT library and other useful libraries.
 
 import BeforeIT as Bit

diff --git a/examples/change_expectations.jl b/examples/change_expectations.jl
@@ -1,3 +1,5 @@
+# # Changing expectations via function overloading
+
 # In this tutorial we will illustrate how to experiment with different expectations of the agents in the model.
 
 import BeforeIT as Bit

diff --git a/examples/get_predictions.jl b/examples/get_predictions.jl
@@ -1,4 +1,4 @@
-# In this tutorial we illustrate how to 
+# In this tutorial we illustrate how to get predictions from the model for a number of quarters starting from previous simulations.
 
 using BeforeIT, FileIO
 using Dates

diff --git a/examples/multithreading_speedup.jl b/examples/multithreading_speedup.jl
@@ -1,3 +1,5 @@
+# # Multithreading speedup for large models
+
 # In this tutorial we illustrate how to make use of multi threading in BeforeIT to allow for faster 
 # executions of single simulation runs.
 

diff --git a/examples/scenario_analysis_via_overload.jl b/examples/scenario_analysis_via_overload.jl
@@ -1,3 +1,5 @@
+# # Scenario analysis via function overloading
+
 # In this tutorial we will illustrate how to perform a scenario analysis by running the model multiple times
 # under a specific shock and comparing the results with the unshocked model.
 

diff --git a/examples/scenario_analysis_via_shock.jl b/examples/scenario_analysis_via_shock.jl
@@ -1,3 +1,5 @@
+# # Scenario analysis via custom shocks
+
 # In this tutorial we will illustrate how to perform a scenario analysis by running the model multiple times
 # under a specific shock and comparing the results with the unshocked model.