add documentation pages

* introduction
* model structure
* presentations

docs/book.toml

@@ -4,3 +4,7 @@ language = "en"
 multilingual = false
 src = "src"
 title = "Elk Island National Park Simmulation"
+
+[output.html]
+no-section-label = true # no numbers in front of sections
+default-theme = "light"

docs/src/introduction.md

@@ -0,0 +1,54 @@
+# Introduction
+The EINP Model is a simple MARS model that incorporates georeferenced raster and vector data. The model's environment represents the Elk Island National Park in Alberta, Canada. This area is modelled as a grid layer with georeferenced cells.
+
+We simulate the behaviour of Bison, Moose and Elk inside the park, using agents.
+
+Our goal is to provide an initial impression of how the animal populations evolves over time to make an estimate of to total carrying capacity of Elk Island National Park.
+
+> Note: In its current state the model does not represent real animal behaviour accurately, and we hope that more features can be added in the future.
+
+## Quickstart
+To use the model clone the repository by running:
+```bash
+git clone https://github.com/Red-Sigma/einp-model.git
+```
+
+Then go into the newly downloaded project and run the simulation:
+```bash
+cd einp-model/GeoRasterBlueprint/
+dotnet run -sm config.json
+```
+
+If you want more details and options on how to run the simulation please have a look at [Running & Output](./running.md)
+
+## Project Structure
+
+After running `git clone` you should have a folder that looks similar to the one below.
+
+```bash
+einp-model/
+├── docs/
+├── GeoRasterBlueprint/
+│   ├── Model/
+│   ├── Resources/
+│   ├── config.json
+│   ├── GeoRasterBlueprint.csproj
+│   ├── Program.cs
+│   └── run.sh
+├── GeoRasterBlueprint.sln
+├── LICENSE
+└── README.md
+```
+
+- `docs/`: the source of [red-sigma.github.io/einp-model](https://red-sigma.github.io/einp-model/)
+- `GeoRasterBlueprint/`: contains most of the model source
+    - `Model/`: source code for layers and agents
+    - `Resources/`: assets like the spawn locations of the animals
+    - `config.json`: the main configuration file that parametrizes the model
+    - `GeoRasterBlueprint.csproj`: a configuration file of the .NET framework
+    - `Program.cs`: the main entry point where the simulation starts
+    - `run.sh`: a convenience [bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) script to run the model from a terminal
+- `GeoRasterBlueprint.sln`: a .NET solution file for use with Visual Studio
+- `LICENSE`: a copy of the MIT-license under which this project is licensed
+- `README.md`: a file describing the project
+

docs/src/model_structure.md

@@ -0,0 +1,16 @@
+# Model Structure and Resources
+
+The following components and resources make up the model:
+
+- `Bison`: This agent type models a bison that moves around randomly in the Elk Island National Park. When its Energy is below a certain threshold, it queries the WaterLayer (see below) for a water source to navigate to. Bison agents are parameterized with the **bisons.csv** file in the `Resources` folder.
+
+- `Moose`: This agent type models a moose that moves around randomly in the Elk Island National Park. When its Energy is below a certain threshold, it queries the WaterLayer (see below) for a water source to navigate to. Moose agents are parameterized with the **moose.csv** file in the `Resources` folder.
+
+- `Elk`: This agent type models an elk that moves around randomly in the Elk Island National Park. When its Energy is below a certain threshold, it queries the WaterLayer (see below) for a water source to navigate to. Bison agents are parameterized with the **elks.csv** file in the `Resources` folder.
+
+- `Perimeter`: This vector layer holds the perimeter of the Elk Island National Park. The georeferenced data are provided by the `einp_perimeter.geojson` file in the `Resources/` folder.
+
+- `WaterLayer`: The raster layer holds a set of pixels that represent water sources in the Elk Island National Park. The georeferenced data of the water sources are provided by the `einp_water_spots.geojson` file in the `Resources/` folder.
+
+- `LandscapeLayer`: This layer holds a grid of cells. Each cell is referenced by geo-coordinates. The georeferenced data contained in the `Model` folder are used to determine which cell is accessible (i.e., within the perimeter) and inaccessible (i.e., outside the perimeter).
+

docs/src/presentations.md

@@ -0,0 +1,8 @@
+# Interim presentations
+
+Presentations that were used to show our progress to the other people in the course.
+
+- [Presentation 1 on 11th November 2023](./assets/01_Presentation_06_Nov_23.pdf)
+- [Presentation 2 on 18th December 2023](./assets/02_Presentation_18_Dez_23.pdf)
+- [Presentation 3 on 29th January 2024]()
+  - TODO: add presentation