README.md

DPMFA

If you run into any problems please create a new issue at the upstream repository.

Usage example

0. [Optional] Create a virtual environment for the project:

$ mkvirtualenv dpmfa

1. Install the package:

$ pip install dpmfa

2. Download the example from this repository, then install the required dependencies:

$ pip install -r example/requirements.txt

3. Then, run the example:

$ python example/plots.py

You should now have a directory experiment_output/ with the results of the example simulation.

Development

First, clone the repo:

$ git clone <url-of-this-repo>

[Optional] Create a virtual environment for the project:

$ mkvirtualenv dpmfa

Install the required dependencies:

$ pip install -r requirements.txt -r requirements-dev.txt

Install the git hooks with pre-commit:

$ pre-commit install

Running tests:

$ py.test