Home

Epiabm Home

Introduction

This Wiki hosts more extensive documentation for our model than can be contained in the README. It is distinct from our online documentation, which hosts complete code documentation for both the python and C++ backends.

In particular, this wiki will outline the structure of the model and explain its mathematical formulation. We have tried to replicate the Ferguson's CovidSim as far as possible, but there have been places were this has not been possible or desirable - these are detailed in Differences to Ferguson Model. Furthermore, there are sections where we have added a simpler/more user-friendly implementation in comparison to the Ferguson Model - these are listed in Comparison to Ferguson Model.

Git Wiki Usage

For users, you may clone the wiki to your computer as below:
$ git clone https://github.com/SABS-R3-Epidemiology/epiabm.wiki.git
This allows you to edit the wiki pages locally, as you change your code. You can also branch off this, although these branches will be separate to branches in the main repo, and will only be visible online when merged onto the default (main) branch.