Skip to content
Snippets Groups Projects
Commit da624c09 authored by Rob Moss's avatar Rob Moss
Browse files

Simplify the package README

parent 4a928c29
No related branches found
No related tags found
No related merge requests found
......@@ -4,24 +4,13 @@ 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.
A bootstrap particle filter that can be used for recursive Bayesian estimation and forecasting.
See the `online documentation <https://pypfilt.readthedocs.io/>`_ for tutorials, how-to guides, and API documentation.
License
-------
The code is distributed under the terms of the BSD 3-Clause license (see
The code is distributed under the terms of the `BSD 3-Clause license <https://opensource.org/licenses/BSD-3-Clause>`_ (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/>`_.
......@@ -29,17 +18,14 @@ The code is distributed under the terms of the BSD 3-Clause license (see
Installation
------------
Clone this repository and execute::
To install the latest release::
python setup.py install
pip install pypfilt
If you don't have admin rights, install the package locally::
To install the latest release with plotting support (requires `matplotlib <http://matplotlib.org/>`_)::
python setup.py install --user
pip install pypfilt[plot]
Dependencies
------------
To install the latest development version, clone this repository and run::
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.
pip install .
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment