-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: small update, add recognition of help by @arnauqb
- Loading branch information
Showing
3 changed files
with
19 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
@@ -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+). | ||
|
@@ -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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters