diff --git a/README.md b/README.md index 94fcb4d9d5f5d78fed069f87df17e08e161380e5..51a92acb1642f84540f64a65fddb65a00928c156 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ This is an example project to demonstrate Literate Programming to create [NetLogo](https://ccl.northwestern.edu/netlogo/) models from ODD+C protocols using [Yarner](https://github.com/mlange-42/yarner). +## How to use this project + +TODO + ## Rabies model - ODD protocol ### Purpose @@ -75,8 +79,16 @@ end ### Design concepts +Fox families as the only model entities live on a rectangular grid of habitat patches. Patches can be empty or occupied. + +Reproduction and juvenile dispersal are subsumed under a single process [Dispersal](#dispersal). Once a year, a certain number of female offspring disperses from each fox family. Time and target location of dispersal are stochastic. Dispersal is restricted by a maximum dispersal radius. + +Fox families can become infected with Rabies. Rabies can be transmitted to the 8 immediate neighbouring families. Infection is stochastic and infection probability depends on the number of infected neighbours. + ### Initialization +The model is initialized by populating each habitat patch with a `S`usceptible fox family. One randomly selected family is infected. + ```netlogo ;- Setup to setup @@ -97,6 +109,8 @@ end ### Input data +The model uses no input data. + ### Submodels ```netlogo