Skip to content

Commit 71e15f1

Browse files
Merge pull request #9 from americocunhajr/americocunhajr-patch-3
Update README.md
2 parents 225c16c + 02c9fde commit 71e15f1

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<img src="logo/EPIDEMIC.png" width="50%">
1+
## Epidemiology Educational Code
22

33
**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:
44
- **Modeling:** which uses differential equation-based compartmental models to emulate the dynamic behavior of homogeneous populations during an epidemic scenario;
@@ -7,7 +7,7 @@
77

88
The current stable version of **EPIDEMIC** is available on GitHub:
99

10-
https://github.com/americocunhajr/EPIDEMIC
10+
<a href="https://github.com/americocunhajr/EPIDEMIC" target="_blank">https://github.com/americocunhajr/EPIDEMIC</a>
1111

1212
In the figure below, it is possible to observe the EPIDEMIC organization structure.
1313

@@ -34,7 +34,7 @@ This EPIDEMIC package includes the following files:
3434
**FORECASTS:**
3535
- epidemic_forecast.m
3636

37-
## Tutorial
37+
### Tutorial
3838

3939
A tutorial style user guide for **EPIDEMIC** is available in English and Portuguese:
4040

@@ -43,22 +43,22 @@ A tutorial style user guide for **EPIDEMIC** is available in English and Portugu
4343
[EPIDEMIC_Tutorial_PT.pdf](https://github.com/americocunhajr/EPIDEMIC/blob/master/Docs/EPIDEMIC_Tutorial_PT.pdf)
4444

4545

46-
## Installation and use
46+
### Installation and use
4747

4848
To run the EPIDEMIC code, follow these steps:
4949

50-
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: <a href="https://github.com/americocunhajr/EPIDEMIC" target="_blank">https://github.com/americocunhajr/EPIDEMIC</a>;
5151

5252
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;
5353

5454
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.
5555

5656

57-
## Octave/Matlab compatibility
57+
### Octave/Matlab compatibility
5858

5959
**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.
6060

61-
## Team:
61+
### Team:
6262

6363
**Faculty/Researchers:**
6464
- Americo Cunha
@@ -83,7 +83,7 @@ To run the EPIDEMIC code, follow these steps:
8383
- Luthiana Soares
8484

8585

86-
## Citing EPIDEMIC
86+
### Citing EPIDEMIC
8787

8888
We ask users to cite the following manual in any publications reporting work done with **EPIDEMIC**:
8989
- 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
102102
}
103103
```
104104

105-
## License
105+
### License
106106

107107
**EPIDEMIC** is released under the MIT license. See the LICENSE file for details. All new contributions must be made under the MIT license.
108108

109109
<img src="logo/mit_license_red.png" width="10%">
110110

111-
## Funding
111+
### Funding
112112

113113
<img src="logo/faperj.jpg" width="20%"> &nbsp; &nbsp; <img src="logo/cnpq.png" width="20%"> &nbsp; &nbsp; <img src="logo/capes.png" width="10%">
114114

115-
## Institutional support
115+
### Institutional support
116116

117117
<img src="logo/uerj_logo_cor.jpg" width="13%"> &nbsp; &nbsp; <img src="logo/ufrj_logo_cor.png" width="10%"> &nbsp; &nbsp; <img src="logo/ufu_logo_cor.png" width="12%"> &nbsp; &nbsp; <img src="logo/ifms_logo_cor.png" width="15%"> &nbsp; &nbsp; <img src="logo/unesp_logo_cor.png" width="25%">
118118

119-
## Contribution to code and contact
119+
### Contribution to code and contact
120120

121121
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

Comments
 (0)