Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #9

Merged
merged 1 commit into from
Jul 17, 2024
Merged

Update README.md #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="logo/EPIDEMIC.png" width="50%">
## Epidemiology Educational Code

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

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

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

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

Expand All @@ -34,7 +34,7 @@ This EPIDEMIC package includes the following files:
**FORECASTS:**
- epidemic_forecast.m

## Tutorial
### Tutorial

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

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


## Installation and use
### Installation and use

To run the EPIDEMIC code, follow these steps:

1) Access the EPIDEMIC repository and download the folder with the code: [www.github.com/americocunhajr/EPIDEMIC](https://github.com/americocunhajr/EPIDEMIC);
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>;

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;

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.


## Octave/Matlab compatibility
### Octave/Matlab compatibility

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

## Team:
### Team:

**Faculty/Researchers:**
- Americo Cunha
Expand All @@ -83,7 +83,7 @@ To run the EPIDEMIC code, follow these steps:
- Luthiana Soares


## Citing EPIDEMIC
### Citing EPIDEMIC

We ask users to cite the following manual in any publications reporting work done with **EPIDEMIC**:
- Pavlack et al., (2022). EPIDEMIC: Epidemiology Educational Code. Journal of Open Source Education, 5(50), 149, https://doi.org/10.21105/jose.00149
Expand All @@ -102,20 +102,20 @@ We ask users to cite the following manual in any publications reporting work don
}
```

## License
### License

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

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

## Funding
### Funding

<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%">

## Institutional support
### Institutional support

<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%">

## Contribution to code and contact
### Contribution to code and contact

Any EPIDEMIC user can contribute the code or seek support via email americo.cunha@uerj.br 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.
Loading