business package

Provide the business logic for rural water supplies.

Solves the ‘hydraulic design problem’ and the ‘hydraulic check problem’ for two typologies of water supply, fit for the rural environment: gravity and station.

Modules

The public API of ruralwater is composed of two modules:

• gravity:

  models the transport of water by gravity

• station:

  models the transport of water from a borehole to a reservoir

Subpackages

• business.commons package
• business.gravity package
• business.groundwater package
• business.helpers package
• business.interface package
• business.manufacturers package
• business.station package
• business.tests package

Submodules

business.loggers module

Module to handle logging of ruralwater. To be moved into ‘microservices’ package.

Functions

logger_factory

factory of loggers for each module

business.loggers.logger_factory(module_name)

Parameters

module_name (string) – the name of the module which is requesting an instance of logger.

Returns

The logger object from the standard python library.

Return type

logger