BONSAI ppf

The BONSAI ppf Python package is a part of the Getting The Data Right project.

Please describe here briefly the purpose and content of the package. A full documentation of the ppf package can be found here.

Installation

To install the ppf package as a standalone type in the command line:

pip install git+ssh://git@gitlab.com/bonsamurais/bonsai/util/ppf@<version>

To install as a dependency in a package add to section install_requires of file setup.cfg:

ppf @ git+ssh://git@gitlab.com/bonsamurais/bonsai/util/ppf@<version>

How to use

You can use the package from the command line or import it in your Python source code.

In the case of tasks, in the command line:

util_ppf -r config.yaml

where config.yaml is described further below.

To import within Python add to the preamble of the script:

import ppf

Getting started

The package contains test data that can be extracted by writing in the command line:

util_ppf -e <data_folder>

or

util_ppf -o <data_folder>

Option -e does not overwrite if folder already exists.

Assuming that the Python package will execute task ppf, a folder called ppf/ will have been created. Therein is a file config.yaml which illustrates the expected syntax.