Skip to main content

Storage, Retrieval, and Versioning of Infrastructure Networks

Project description

# Network Store Service

## Overview

This package implements a hydraulic network topology store by mapping structures such as tanks, reservoirs, and junctions onto the nodes of a graph, whereas structures such as channels, pipes, pumps, and valves are mapped onto graph edges.

The structure models are implemented as separate, open-source libraries:

Furthermore, KISTERS maintains a python client for easy scripting against the Network Store Service: [kisters.network_store.client.network](https://gitlab.com/kisters/network-store/client)

## Licence

The KISTERS Network Store Service (package name kisters.network-store.service) is distributed under the GNU Affero General Public License v3.0 (AGPLv3), with commercial licences available. See the [AGPLv3-LICENCE](AGPLv3-LICENCE) file for details about the AGPLv3 licence. To receive a commercial licence, contact [KISTERS](https://www.kisters.de/).

## Running

The service can be run locally using uvicorn (installable with pip):

`shell uvicorn kisters.network_store.service.padp.asgi.app:create_app --factory `

### Environment Variables

Variable | Default | Description |
———————– | ——- | ——————————————————– |
DEPLOYMENT_URL | - | The public url that the ASGI service is exposed at |
MONGODB_HOST | - | The MongoDB connection URI for the storage backend |
ENABLE_VIEWER | True | Enable experimental network viewer feature in Swagger UI |
ENABLE_ACCESS_CONTROL | False | Enable access control on all endpoints |

## Versioning

The package versioning attempts to follow semantic versioning. If the API is extended, a minor version will be released. If there is a breaking change to the API, the major version will be increased. Note that the modules exported by the python package are considered internal, the versions are based on the ASGI interface alone.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

File details

Details for the file kisters.network_store.service-1.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for kisters.network_store.service-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0e2f0b080adf5d05e484e29a40c397dd4e4c9e74826b316568a8d4f6a5d1d744
MD5 6a17d8d66c537f378ae824d026b67416
BLAKE2b-256 52b9654770d4ea9e67dce745e8f6881f184afdb4937acf5922467ad719c020a4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page