You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
<imgsrc="logo/EPIDEMIC.png"width="50%">
1
+
## Epidemiology Educational Code
2
2
3
3
**EPIDEMIC: Epidemiology Educational Code** is an easy-to-run educational Matlab toolkit for epidemiological analysis, which offers functionalities for modeling an epidemic, monitoring its progress and forecasting the underling numbers of interest. This code is, first of all, an educational tool for researchers and students who are interested in computational epidemiology. The programs and tutorials are designed to offer good introductory material for beginners in the field. But they can also be used to analyze epidemic data, as well as in the construction of some simplistic epidemic models. The package is structured in 3 independent modules:
4
4
-**Modeling:** which uses differential equation-based compartmental models to emulate the dynamic behavior of homogeneous populations during an epidemic scenario;
@@ -7,7 +7,7 @@
7
7
8
8
The current stable version of **EPIDEMIC** is available on GitHub:
1) Access the EPIDEMIC repository and download the folder with the code: [www.github.com/americocunhajr/EPIDEMIC](https://github.com/americocunhajr/EPIDEMIC);
50
+
1) Access the EPIDEMIC repository and download the folder with the code: <ahref="https://github.com/americocunhajr/EPIDEMIC"target="_blank">https://github.com/americocunhajr/EPIDEMIC</a>;
51
51
52
52
2) The working directory of the compatible software (Octave or MATLAB) is placed in the place where the folder with the EPIDEMIC codes is located and it is executed via the terminal;
53
53
54
54
3) If it is in the module Modeling, the executable file that generates the simulations is the files main. In the files rhs is possible to modify the differential equations, if that is the interest. In the module Trends, the executable file is epidemic_trends.m. And in the module Forecasts the executable file is epidemic_forecasts.m. In the tutorials you can get more information on how to use the codes.
55
55
56
56
57
-
## Octave/Matlab compatibility
57
+
###Octave/Matlab compatibility
58
58
59
59
**EPIDEMIC** was developed to be 100% compatible with the Octave and Matlab platforms. EPIDEMIC codes have been tested on at least GNU Octave 5.2.0 and MATLAB R2016b versions.
60
60
61
-
## Team:
61
+
###Team:
62
62
63
63
**Faculty/Researchers:**
64
64
- Americo Cunha
@@ -83,7 +83,7 @@ To run the EPIDEMIC code, follow these steps:
83
83
- Luthiana Soares
84
84
85
85
86
-
## Citing EPIDEMIC
86
+
###Citing EPIDEMIC
87
87
88
88
We ask users to cite the following manual in any publications reporting work done with **EPIDEMIC**:
89
89
- Pavlack et al., (2022). EPIDEMIC: Epidemiology Educational Code. Journal of Open Source Education, 5(50), 149, https://doi.org/10.21105/jose.00149
@@ -102,20 +102,20 @@ We ask users to cite the following manual in any publications reporting work don
102
102
}
103
103
```
104
104
105
-
## License
105
+
###License
106
106
107
107
**EPIDEMIC** is released under the MIT license. See the LICENSE file for details. All new contributions must be made under the MIT license.
Any EPIDEMIC user can contribute the code or seek support via email [email protected] or open an [issue](https://github.com/americocunhajr/EPIDEMIC/issues). You can correct spelling or grammatical errors, suggest improvements and file bugs. If you find a bug, file the issue illustrating the bug with a minimal reproducible example. Experience reports on the use of EPIDEMIC are also welcome. If you want to suggest the insertion of a compartmental model in the Modeling module, it is necessary to send a preview of the code structure following the code pattern of the other compartmental models.
0 commit comments