# Epidemic forecasting in Python¶

Welcome to the epifx documentation. This package uses a bootstrap particle filter (pypfilt) to generate forecasts of infectious disease epidemics.

Note

This documentation assumes that you are already familiar with the pypfilt package. If this is not the case, please read the pypfilt Getting Started tutorial before proceeding.

The epifx package provides a number of new components and features on top of those provided by the pypfilt package, including:

• Epidemic models
• Observation models for case count data
• Epidemic summary statistics
• Fitting flexible model prior distributions
• Running forecasts from the command-line (todo: worked TOML example)

## Installation¶

You can install epifx using pip, preferably in a virtual environment:

pip install epifx


See the pypfilt documentation for further details about installation.

## License¶

The code is distributed under the terms of the BSD 3-Clause license (see LICENSE), and the documentation is distributed under the terms of the Creative Commons BY-SA 4.0 license.