Skip to content

Commit

Permalink
Merge branch 'Documentation' of github.com:SABS-R3-Epidemiology/rEpia…
Browse files Browse the repository at this point in the history
…bm into Documentation
  • Loading branch information
anitaapplegarth committed Jan 22, 2025
2 parents 0c6297c + bf1a925 commit 262e612
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,21 @@ To model an epidemic, contact events are represented by the population spatial s
<div style="display: flex; gap: 20px;">
<div style="flex: 1;">
<img src="./images/population_spatial_structure.png" alt="Population spatial structure" width="100%">
<p>Figure 1. Population Spatial Structure: The environment is modelled using <a href="https://github.com/SABS-R3-Epidemiology/EpiGeoPop">EpiGeoPop</a>, which takes a region of interest, creates layers of sub-regions of different types and populates these with individuals.</p>
<p><figcaption><i>Figure 1. Population Spatial Structure: The environment is modelled using <a href="https://github.com/SABS-R3-Epidemiology/EpiGeoPop">EpiGeoPop</a>, which takes a region of interest, creates layers of sub-regions of different types and populates these with individuals.</p><figcaption><i>
</div>
<div style="flex: 1;">
<img src="./images/infection_progression.jpg" alt="Infection progression" width="100%">
<p>Figure 2. Infection Progression: The infection progression is represented using a <a href="https://en.wikipedia.org/wiki/Compartmental_models_in_epidemiology">compartment model</a> which tracks the daily progress of the disease within an individual.</p>
<p><figcaption><i>Figure 2. Infection Progression: The infection progression is represented using a <a href="https://en.wikipedia.org/wiki/Compartmental_models_in_epidemiology">compartment model</a> which tracks the daily progress of the disease within an individual.<i><figcaption></p>
</div>
</div>

## Running a simulation
The basic flow of a simulation is described below and an overview of the process is illustrated in Figure 4. The instructions to run a basic simulation is also given; we will use 'Andorra' as the region of interest. A more detailed, complex example is illustrated in this jupyter notebook (ADD LINK). Also, [the Wiki](https://github.com/SABS-R3-Epidemiology/epiabm/wiki/Overview-of-the-Ferguson-Model) details optional parameters available to the user as well as those whose values are mentioned, but changing them is not recommended.

![Figure 4. Overview of simulation workflow: These steps are required to run a simulation.](./images/program_workflow.png)
<figure>
<img src="./images/program_workflow.png" alt="Overview of simulation workflow">
<figcaption><i>Figure 4. Overview of simulation workflow: These steps are required to run a simulation.</i></figcaption>
</figure>


### Step 1: Set up rEpiabm
Expand Down

0 comments on commit 262e612

Please sign in to comment.