Skip to content
Snippets Groups Projects
Commit ebca44a1 authored by Martin Lange's avatar Martin Lange
Browse files

how to use the project

parent 0e6e4f14
Branches main
No related tags found
1 merge request!4How it works, how to use it
Pipeline #16031 passed with stage
in 14 seconds
......@@ -2,7 +2,7 @@
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).
The document you are currently reading contains the ODD protocol ([Grimm et al. 2006, 2010](#references)) of a model for Rabies in red foxes. The ODD description is interleaved with code blocks showing the NetLogo code used for the described aspect. Using the Literate Programming tool [Yarner](https://github.com/mlange-42/yarner), these code blocks are extracted from the document and arranged into a working NetLogo model.
The document you are currently reading contains the [ODD protocol](#rabies-model-odd-protocol) ([Grimm et al. 2006, 2010](#references)) of a model for Rabies in red foxes. The ODD description is interleaved with code blocks showing the NetLogo code used for the described aspect (ODD+C). Using the Literate Programming tool [Yarner](https://github.com/mlange-42/yarner), these code blocks are extracted from the document and arranged into a working NetLogo model.
## How it works
......@@ -32,7 +32,22 @@ For a comprehensive guide and a description of all features, see the [Yarner doc
## How to use it
TODO
**Read the ODD**
The best way to understand how to use Literate Programming with Yarner to create a NetLogo model from an ODD protocol is to read the below [ODD+C of the Rabies model.](#rabies-model-odd-protocol) It contains the complete code of the model, except the UI elements.
**Run from downloads**
The [Downloads](https://git.ufz.de/oesa/literate-netlogo/-/jobs/artifacts/main/download?job=build) contain a folder `model` with files `Model.nlogo` and `Code.nls`. Open the `.nlogo` file with NetLogo.
**Build from sources**
1. [Install Yarner](https://mlange-42.github.io/yarner/installation.html)
2. Clone the sources of this example:
`git clone https://git.ufz.de/oesa/literate-netlogo.git`
3. `cd` into folder `literate-netlogo`
4. Run command `yarner` to extract the model code
5. Open file `model/Model.nlogo` with NetLogo
## Rabies model - ODD protocol
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment