README.md

Epigrass

If you use epigrass in your research, please use the following DOI to cite it:

or this bibtex entry.

@software{flavio_codeco_coelho_2021_4554753,
  author       = {Flávio Codeço Coelho},
  title        = {fccoelho/epigrass: COVID19},
  month        = feb,
  year         = 2021,
  publisher    = {Zenodo},
  version      = {v3.0.2},
  doi          = {10.5281/zenodo.4554753},
  url          = {https://doi.org/10.5281/zenodo.4554753}
}

Epidemiological Geo-referenced Analysis and Simulation system

Epigrass is a Python Library aimed at making the simulation of metapopulation models as easy as possible. Documentation is available here.

Installation

External dependencies

Besides installing epigrass from the PyPI, as described below you will need to install the following external dependencies:

• redis server you need to have a redis server running. You can install it from the redis website

You can install Epigrass directly from PyPI, the Python Package Index. For mode details, check the docs

Installing from the repository

If you clone the repository, you can install Epigrass with the following command:

$ uv sync

Running demos

The source distribution comes with a few demos.

$ cd demos
$ uv run epirunner rio.epg

This will run the demo for the city of Rio de Janeiro.

Getting started building your own models

Folow these instructions.