pferd/DEV.md

PFERD Development Guide

PFERD is packaged following the Python Packaging User Guide (in particular this and this guide).

Setting up a dev environment

The use of venv is recommended. To initially set up a development environment, run these commands in the same directory as this file:

$ python -m venv .venv
$ . .venv/bin/activate
$ pip install --editable .

After this, you can use PFERD as if it was installed normally. Since PFERD was installed with --editable, there is no need to re-run pip install when the source code is changed.

For more details, see this part of the Python Tutorial and this section on "development mode".

Contributing

When submitting a PR that adds, changes or modifies a feature, please ensure that the corresponding documentation is updated.

In your first PR, please add your name to the LICENSE file.