aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 14 insertions, 6 deletions
diff --git a/README.md b/README.md
index 2ba58f1..a22aa08 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,19 @@
# Infectious-Disease-Modeling
-Original code by [JasonXu314](https://github.com/JasonXu314/covid-19-project/) and [Lewuathe](https://github.com/Lewuathe/COVID19-SIR)
+A project to modeling infectious diseases with the SIR model and variations.
+
+![](https://raw.githubusercontent.com/Ta180m/Infectious-Disease-Modeling/master/SARS-ESIR.png)
+
+![](https://raw.githubusercontent.com/Ta180m/Infectious-Disease-Modeling/master/COVID-19-ESIR.png)
+
+## Usage
For SARS in Hong Kong use
-`./solver2.py --country=Hong_Kong --popcountry=20000 --initial=1000 --disease=SARS --start=4/10/03`
+`./solver2.py --country=Hong_Kong --popcountry=20000 --initial=1000 --disease=SARS --start=4/10/03 --mode={SIR,Linear,ESIR,SEIR}`
For COVID-19 in the US use
-`./solver2.py --popcountry=3000000 --initial=100`
-
+`./solver2.py --popcountry=3000000 --initial=100 --mode={SIR,Linear,ESIR,SEIR}`
-## Usage
```
usage: solver2.py [-h] [--mode {SIR,Linear,ESIR,SEIR}]
[--data [{Actual,S,I,R,E} [{Actual,S,I,R,E} ...]]]
@@ -56,4 +60,8 @@ optional arguments:
the population of the model (defaults to 10000)
--initial INITIAL, -I INITIAL
initial infected people (defaults to 1)
-``` \ No newline at end of file
+```
+
+## Credits
+
+Original code by [JasonXu314](https://github.com/JasonXu314/covid-19-project/) and [Lewuathe](https://github.com/Lewuathe/COVID19-SIR) \ No newline at end of file