Python Module SWA-models

Utilities to run predictive models for:

• Water consumption
• Soil humidity

Installation

To install the module using pip run the following command:

pip install "git+https://gitlab.ost.ch/swa/swa-models.git"

You can check the installation of the module by running:

python -c 'import swa_models as swa; swa.describe()'

which will print some basic information about the module.

If you have a read token for the DB you can test the connection running the following command in a terminal:

swa_info <token>

Documentation

The documentation is hosted at http://swa.pages.gitlab.ost.ch/swa-models

To generate the documentation in a local copy of this repository, do the following:

pip install --upgrade -r requirements.txt

then:

cd doc
make html

The documentation will be generated in build/html/