Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
particle-filter-for-python
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Rob Moss
particle-filter-for-python
Commits
da624c09
Commit
da624c09
authored
4 years ago
by
Rob Moss
Browse files
Options
Downloads
Patches
Plain Diff
Simplify the package README
parent
4a928c29
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.rst
+9
-23
9 additions, 23 deletions
README.rst
with
9 additions
and
23 deletions
README.rst
+
9
−
23
View file @
da624c09
...
...
@@ -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 execut
e::
To install the latest releas
e::
p
ython setup.py install
p
ip 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/>`_)
::
p
ython setup.py install --user
p
ip 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 .
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment