IHEWAengine package

Subpackages

Submodules

IHEWAengine.engine module

Engine

class IHEWAengine.engine.Base[source]

Bases: object

This Base class

Load base.yml file.

Parameters

  • product (str) – Product name of data products.

  • is_print (bool) – Is to print status message.

class IHEWAengine.engine.Engine(workspace='', config='', **kwargs)[source]

Bases: IHEWAengine.engine.Base

Engine class

After initialise the class, data downloading will automatically start.

Parameters

  • workspace (str) – Directory to config.yml.

  • config (str) – Configuration yaml file name.

  • kwargs (dict) – Other arguments.

static get_config(self)[source]

IHEWAengine.exception module

Exception

https://julien.danjou.info/python-exceptions-guide/

exception IHEWAengine.exception.IHEClassInitError(mod, msg=None)[source]

Bases: Exception

IHEClassInitError Class

Parameters

  • mod (str) – Module name.

  • msg (bool) – Extra message.

exception IHEWAengine.exception.IHEFileError(file, msg=None)[source]

Bases: Exception

IHEFileError Class

Parameters

  • file (str) – File name.

  • msg (bool) – Extra message.

exception IHEWAengine.exception.IHEKeyError(key, val, msg=None)[source]

Bases: Exception

IHEKeyError Class

Parameters

  • key (str) – Key name.

  • val (list) – Key name list.

  • msg (bool) – Extra message.

exception IHEWAengine.exception.IHEStringError(vname, msg=None)[source]

Bases: Exception

IHEStringError Class

Parameters

  • vname (str) – Variable name.

  • msg (bool) – Extra message.

exception IHEWAengine.exception.IHETypeError(vname, rtype, vdata, msg=None)[source]

Bases: Exception

IHETypeError Class

Parameters

  • vname (str) – Variable name.

  • rtype (str) – Required type.

  • vdata (float) – Variable value.

  • msg (bool) – Extra message.

Module contents

IHEengine: IHE Water Accounting Engine Tools

class IHEWAengine.Engine(workspace='', config='', **kwargs)[source]

Bases: IHEWAengine.engine.Base

Engine class

After initialise the class, data downloading will automatically start.

Parameters

  • workspace (str) – Directory to config.yml.

  • config (str) – Configuration yaml file name.

  • kwargs (dict) – Other arguments.

static get_config(self)[source]