PyRoss API

PyRoss banner

PyRoss is a numerical library for inference, prediction and non-pharmaceutical interventions in age-structured epidemiological compartment models. The library is designed to be model-agnostic and allows the user to define models using a Python dictionary.

The library supports models formulated stochastically (as chemical master equations) or deterministically (as systems of differential equations). Inference on pre-defined or user-defined models is performed using model-adapted Gaussian processes on the epidemiological manifold or its tangent space. This method allows for latent variable inference and fast computation of the model evidence and the Fisher information matrix. These estimates are convolved with the instrinsic stochasticty of the dynamics to provide Bayesian forecasts of the progress of the epidemic.

Installation

From a checkout of PyRoss GitHub repository

This is the recommended way as it downloads a whole suite of examples along with the package.

Install PyRoss and an extended list of dependencies using

>> git clone https://github.com/rajeshrinet/pyross.git
>> cd pyross
>> pip install -r requirements.txt
>> python setup.py install

Install PyRoss and an extended list of dependencies, via Anaconda, in an environment named pyross:

>> git clone https://github.com/rajeshrinet/pyross.git
>> cd pyross
>> make env
>> conda activate pyross
>> make

Via pip

Install the latest PyPI version

>> pip install pyross

See also installation instructions and more details in the README.md on GitHub.

Tutorial examples

Please have a look at the examples folder for Jupyter notebook examples on GitHub.