Skip to content

Commit

Permalink
docs: small update, add recognition of help by @arnauqb
Browse files Browse the repository at this point in the history
  • Loading branch information
AldoGl committed May 23, 2024
1 parent 9dd0342 commit 5141ebf
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 10 deletions.
13 changes: 11 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ To install BeforeIT.jl, simply open a Julia REPL by writing `julia` in your term

```julia
using Pkg
Pkg.add(url="[email protected]:bancaditalia/BeforeIT.jl.git")
Pkg.add("BeforeIT")
```

## Quick example

To check that the installation worked, try running the model in your terminal following

```julia
using BeforeIT, Plots
using BeforeIT

parameters = BeforeIT.AUSTRIA2010Q1.parameters
initial_conditions = BeforeIT.AUSTRIA2010Q1.initial_conditions
Expand All @@ -42,6 +42,14 @@ 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

```julia
using Plots

plot(data.real_gdp)
```

## License

BeforeIT.jl is released under the GNU Affero General Public License v3 or later (AGPLv3+).
Expand All @@ -59,6 +67,7 @@ Copyright 2024- Banca d'Italia and the authors.
- [Marco Benedetti](https://www.bankit.art/people/marco-benedetti)
- [Sara Corbo](https://www.bankit.art/people/sara-corbo) for the logo design
- [Andrea Gentili](https://www.bankit.art/people/andrea-gentili) for suggesting the name of the pakege
- [Arnau Quera-Bofarull](https://github.com/arnauqb) for help in the deployment of the documentation

## Disclaimer

Expand Down
4 changes: 2 additions & 2 deletions src/agent_actions/government.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Computes government expenditure on consumption and transfers to households.
# Arguments
- `gov::AbstractGovernment`: government object
- `gov`: government object
- `model`: model object
# Returns
Expand Down Expand Up @@ -126,7 +126,7 @@ end
Computes social benefits paid by the government households.
# Arguments
- `gov::AbstractGovernment`: government object
- `gov`: government object
- `model`: model object
# Returns
Expand Down
12 changes: 6 additions & 6 deletions src/model_init/init.jl
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ recursive_namedtuple(d::Dict) = MutableNamedTuple(;Dict(k => recursive_namedtupl
Initializes the model with given parameters and initial conditions.
Parameters:
- parameters::Dict{String, Any}: A dictionary containing the model parameters.
- initial_conditions::Dict{String, Any}: A dictionary containing the initial conditions.
- T::Int: The time horizon of the model.
- typeInt::DataType (optional, default: Int64): The data type to be used for integer values.
- typeFloat::DataType (optional, default: Float64): The data type to be used for floating-point values.
- `parameters`: A dictionary containing the model parameters.
- initial_conditions: A dictionary containing the initial conditions.
- T (integer): The time horizon of the model.
- typeInt: (optional, default: Int64): The data type to be used for integer values.
- typeFloat: (optional, default: Float64): The data type to be used for floating-point values.
Returns:
- model::Model: The initialized model.
"""
function initialise_model(parameters, initial_conditions, T, typeInt = Int64, typeFloat = Float64)
function initialise_model(parameters::Dict{String, Any}, initial_conditions::Dict{String, Any}, T, typeInt::DataType = Int64, typeFloat::DataType = Float64)

###########################################
############# Parameter imports ###########
Expand Down

0 comments on commit 5141ebf

Please sign in to comment.