diff --git a/README.md b/README.md index 72c199984437575113502b63ffde82f62d43aa7e..a76f6536e74db11d0ea97ca835479405eb80e7be 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,25 @@ **An agent-based, socio-economic-ecological model of agricultural landscapes in Europe under the CAP.** +## Description + +Persephone models farmers' decision making and its impact on species in agricultural +landscapes. The aim is to investigate how policies such as the CAP influence farms and +biodiversity. + +It is currently in the very early stages of development. + +## Usage + +Install the latest version of the [Julia](https://julialang.org/downloads/) programming +language. The recommended editors are [VSCode](https://www.julia-vscode.org/) or +[Emacs](https://www.emacswiki.org/emacs/JuliaProgrammingLanguage). +Then, open a Julia commandline and install the +[Agents.jl](https://juliadynamics.github.io/Agents.jl/stable/) framework using +`using Pkg; Pkg.add("Agents")`. + +Run the simulation by executing `run.jl` from the commandline, or loading it from +within a Julia REPL with `include("run.jl")`. ---