Metadata-Version: 2.1
Name: pypfilt
Version: 0.5.5
Summary: Bootstrap particle filter for epidemic forecasting
Home-page: https://bitbucket.org/robmoss/particle-filter-for-python/
Author: Rob Moss
Author-email: rgmoss@unimelb.edu.au
License: BSD 3-Clause License
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Dist: h5py (>=2.2)
Requires-Dist: numpy (>=1.8)
Requires-Dist: scipy (>=0.11)
Provides-Extra: plot
Requires-Dist: matplotlib (>=1.5) ; extra == 'plot'

Bootstrap particle filter for epidemic forecasting
==================================================

Description
-----------

This package implements a bootstrap particle filter, intended for use with
mechanistic infection models to generate forecasts for epidemic outbreaks.

Documentation
--------------

The documentation is `available online <https://pypfilt.readthedocs.io/>`_ and
can be built locally with `sphinx <http://sphinx-doc.org/>`_::

    python setup.py build_sphinx

Note that the `sphinx_rtd_theme <https://github.com/snide/sphinx_rtd_theme/>`_
theme must be installed.

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
<http://creativecommons.org/licenses/by-sa/4.0/>`_.

Installation
------------

Clone this repository and execute::

    python setup.py install

If you don't have admin rights, install the package locally::

    python setup.py install --user

Dependencies
------------

This package requires `h5py <http://www.h5py.org/>`_ 2.2 or newer,
`NumPy <http://www.numpy.org/>`_ 1.8 or newer, and
`SciPy <http://www.scipy.org/>`_ 0.11 or newer.


