Skip to content

Commit

Permalink
Merge pull request #108 from SABS-R3-Epidemiology/read-me-modifs
Browse files Browse the repository at this point in the history
Correction to image file in README
  • Loading branch information
I-Bouros authored Oct 28, 2021
2 parents 47f0eb4 + 3f3d1a8 commit 8725efa
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,16 @@ Two submodels are defined in the program: a deterministic SEIR model and a stoch
## Deterministic SEIR
The deterministic model supposes that the population is large and well-mixed, and that small fluctuations in compartments do not impact the general solution. The conceptualisation of the model is illustrated below, and the parameters are described in a table below.

![SEIR model conceptualisation](./images/seir_conceptualisation.png)
![SEIR model conceptualisation](./images/SEIR_model.png)


| Parameter | Description | Unit |
| ------------- | --------------------------------------------------------------------------------------- | ---- |
| β | Percentage of infected and susceptible encounters per day that lead to transmission | 1/t |
| β | Percentage of infectious and susceptible encounters per day that lead to transmission | 1/t |
| κ | Inverse of the average latent period | 1/t |
| γ | Inverse of the average duration of infectiousness | 1/t |

β > 0 controls the rate of tranmission, κ > 0 the rate at which exposed individuals become infectious, and γ > 0 the rate at which individuals recover.
β > 0 controls the rate of tranmission, κ > 0 the rate at which exposed individuals become infectious, and γ > 0 the rate at which individuals recover. The model also requires initial conditions for each compartment: S(0), E(0), I(0), and R(0), which represent the initial number of people in each category.


The deterministic model solves this set of ODEs:
Expand Down Expand Up @@ -60,14 +60,21 @@ where _(t+1)_ is the next timestep.
 


## Installation procedure
One way to install the module is to download the repositiory to your machine of choice and type the following commands in the terminal.
```bash
git clone https://github.com/SABS-R3-Epidemiology/seirmo.git
cd ../path/to/the/file
```

## Set up
A different method to install this is using `pip`:

Add text on how to install and use module.
```bash
pip install -e .
```

 


## Documentation
Some documentation on the program's classes and methods can be found here: https://seirmo.readthedocs.io/en/latest/

Expand Down
Binary file added images/SEIR_model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8725efa

Please sign in to comment.