-
Notifications
You must be signed in to change notification settings - Fork 5
Home
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 API 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, in Overview of the Ferguson Model. 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.
This model has been built from scratch, and so we have implemented different aspects of the Ferguson model over time. Part of the motivation for this was to allow comparison between different models, and determine the impact of individual aspects of the code. To aid this, we have recorded significant milestones within the project, corresponding to usable sub-models within the development of the full model. These are recorded in the Model Milestones page. A complete description of the parameters used in the model is recorded in the Parameters page.
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.