Skip to main content

Client library for the Kisters Network Store service

Project description

Hydraulic Network Client Library

This library allows connections to remote hydraulic network REST servers. It supports authentication with OpenID Connect.


Install with pip:

> python -m pip install
# or you if also need the water models
> python -m pip install[water]

Example Usage

Create the Kisters REST Client

from kisters.water.rest_client import RESTClient
from kisters.water.rest_client.auth import OpenIDConnect

rest_client = RESTClient(

# Verify the client is set up correctly
# Note: If you have not created any networks yet, this could be an empty list
rest_client.get(("rest", "networks"))
# ['my-network', 'my-other-network', ...]

Connect to a Network

from import Network

# Instantiate the Network class with the network name and client
network = Network("my-network", rest_client)

# You can now access the properties of the network
# [
# FlowBoundary(
#     created=datetime.datetime(2019, 6, 27, 16, 53, 5),
#     uid='flow_boundary',
#     display_name='flow_boundary',
#     location={'x': 0.0, 'y': 0.0, 'z': 0.0},
#     schematic_location={'x': 0.0, 'y': 0.0, 'z': 0.0})
# ,
# ...
# ]

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for, version 0.4.2
Filename, size File type Python version Upload date Hashes
Filename, size (15.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size (17.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page