Metadata-Version: 2.4
Name: epigrass
Version: 4.1.1
Summary: Epidemiological Geo-Referenced Analysis and Simulation System
Author-email: Flávio Codeço Coelho <fccoelho@gmail.com>, Claudia Torres Codeço <claudia.codeco@gmail.com>
License: GPLv3
Project-URL: Homepage, https://epigrass.readthedocs.io
Project-URL: Source, https://github.com/fccoelho/epigrass
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: COPYING
Requires-Dist: altair>=5.5.0
Requires-Dist: cython>=3.0.11
Requires-Dist: dbfread>=2.0.7
Requires-Dist: epimodels>=0.4.3
Requires-Dist: fiona>=1.10.1
Requires-Dist: geopandas>=1.0.1
Requires-Dist: geoviews>=1.14.0
Requires-Dist: gradio>=5.44.1
Requires-Dist: holoviews>=1.20.0
Requires-Dist: hvplot>=0.11.2
Requires-Dist: matplotlib>=3.10.0
Requires-Dist: networkx>=3.4.2
Requires-Dist: numpy>=2.2.0
Requires-Dist: nx-altair>=0.1.6
Requires-Dist: pandas>=2.2.3
Requires-Dist: panel>=1.5.5
Requires-Dist: plotly>=6.3.0
Requires-Dist: pweave>=0.30.3
Requires-Dist: pymysql>=1.1.1
Requires-Dist: recommonmark>=0.7.1
Requires-Dist: redis>=5.2.1
Requires-Dist: scikit-image>=0.25.0
Requires-Dist: shapely>=2.0.6
Requires-Dist: sqlalchemy>=2.0.36
Requires-Dist: sqlobject>=3.11.0
Requires-Dist: tqdm>=4.67.1
Dynamic: license-file

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

[![DOI](https://zenodo.org/badge/59497476.svg)](https://zenodo.org/badge/latestdoi/59497476)
or this bibtex entry.
```bibtex
@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
![dashboard](docs/source/dashboard2.png)
Epigrass is a Python Library aimed at making the simulation of metapopulation models as easy as possible.
Documentation is available [here](https://epigrass.readthedocs.io/en/latest/).

## 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](https://redis.io/download)  
- 
You can install Epigrass directly from PyPI, the Python Package Index.
For mode details, check the [docs](https://epigrass.readthedocs.io/en/latest/install.html#)

## Installing from the repository
If you clone the repository, you can install Epigrass with the following command:
```bash
$ uv sync
```

## Running the Gradio Simulation Builder
Epigrass now includes a modern web-based simulation builder built with Gradio. This interface allows you to create, edit, and run simulations easily.

To launch the simulation builder:
```bash
$ uv run epigrass
```
This will start a local web server and provide a URL (usually `http://127.0.0.1:7860`) where you can access the interface.

## Running demos
The source distribution comes with a few demos.
```bash
$ 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](https://epigrass.readthedocs.io/en/latest/using.html).
