# 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:
- [`kisters.network_store.model_library`](https://gitlab.com/kisters/network-store/model-library):
Base Classes for Network Models
- [`kisters.network_store.model_library.water`](https://gitlab.com/kisters/network-store/model-library-water):
Network Models for Water Infrastructure
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.
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/kisters/network-store/service",
"name": "kisters.network-store.service",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "hydraulics infrastructure graph topology",
"author": "Jesse VanderWees",
"author_email": "jesse.vanderwees@kisters-bv.nl",
"download_url": "",
"platform": null,
"description": "# Network Store Service\n\n## Overview\n\nThis package implements a hydraulic network topology store by mapping\nstructures such as tanks, reservoirs, and junctions onto the nodes of a graph,\nwhereas structures such as channels, pipes, pumps, and valves are mapped onto\ngraph edges.\n\nThe structure models are implemented as separate, open-source libraries:\n\n- [`kisters.network_store.model_library`](https://gitlab.com/kisters/network-store/model-library):\n Base Classes for Network Models\n- [`kisters.network_store.model_library.water`](https://gitlab.com/kisters/network-store/model-library-water):\n Network Models for Water Infrastructure\n\nFurthermore, KISTERS maintains a python client for easy scripting against the\nNetwork Store Service:\n[`kisters.network_store.client.network`](https://gitlab.com/kisters/network-store/client)\n\n## Licence\n\nThe KISTERS Network Store Service (package name\n`kisters.network-store.service`) is distributed under the GNU Affero General\nPublic License v3.0 (AGPLv3), with commercial licences available. See the\n[AGPLv3-LICENCE](AGPLv3-LICENCE) file for details about the AGPLv3 licence. To\nreceive a commercial licence, contact [KISTERS](https://www.kisters.de/).\n\n## Running\n\nThe service can be run locally using uvicorn (installable with pip):\n\n```shell\nuvicorn kisters.network_store.service.padp.asgi.app:create_app --factory\n```\n\n### Environment Variables\n\n| Variable | Default | Description |\n| ----------------------- | ------- | -------------------------------------------------------- |\n| `DEPLOYMENT_URL` | - | The public url that the ASGI service is exposed at |\n| `MONGODB_HOST` | - | The MongoDB connection URI for the storage backend |\n| `ENABLE_VIEWER` | `True` | Enable experimental network viewer feature in Swagger UI |\n| `ENABLE_ACCESS_CONTROL` | `False` | Enable access control on all endpoints |\n\n\n## Versioning\n\nThe package versioning attempts to follow semantic versioning. If the API is\nextended, a minor version will be released. If there is a breaking change to\nthe API, the major version will be increased. Note that the modules exported by\nthe python package are considered internal, the versions are based on the ASGI\ninterface alone.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Storage, Retrieval, and Versioning of Infrastructure Networks",
"version": "1.4.0",
"split_keywords": [
"hydraulics",
"infrastructure",
"graph",
"topology"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "6a17d8d66c537f378ae824d026b67416",
"sha256": "0e2f0b080adf5d05e484e29a40c397dd4e4c9e74826b316568a8d4f6a5d1d744"
},
"downloads": -1,
"filename": "kisters.network_store.service-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a17d8d66c537f378ae824d026b67416",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1633198,
"upload_time": "2022-12-07T14:53:48",
"upload_time_iso_8601": "2022-12-07T14:53:48.992822Z",
"url": "https://files.pythonhosted.org/packages/52/b9/654770d4ea9e67dce745e8f6881f184afdb4937acf5922467ad719c020a4/kisters.network_store.service-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-07 14:53:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "kisters.network-store.service"
}
JSON