Skip to main content

Importer and Exporter for GWSW

Project description

A library for the GWSW-hydx exchange format

RioNED is going to release a new format for exchanging sewerage data called GWSW-hydx. hydxlib can be used to import sewerage data from a hydx format (*.csv) to 3Di native schematisation files.

For more information about GWSW-hydx: https://apps.gwsw.nl/item_hyddef

For more information about the database scheme of 3Di: https://docs.3di.live/

Purporse of this script is to exchange information between different formats. This means that this library doesn’t improve lacking or incorrect data. For example, it doesn’t remove double manholes on the same location. This libary does provide all kinds of checks with warning and error messages.

This tool is currently in development. Therefore only nodes, weirs, orifices and pumpstations are currently supported.

Installation

hydxlib is installed with:

$ pip install hydxlib

Running script

It’s possible to run this tool on command line or with python.

Commandline:

$ run-hydxlib path/to/hydx/dir path/to/threedi.sqlite

Python:

from hydxlib.scripts import run_import_export

run_import_export("path/to/hydx/dir", "path/to/threedi.sqlite")

Installation for development

Clone hydxlib from github and then install locally using pip + virtualenv:

$ virtualenv .venv
$ source .venv/bin/activate
$ pip install -e .[test]

There will be a script you can run like this:

$ run-hydxlib ...

It runs the main() function in hydxlib/scripts.py, adjust that if necessary. The script is configured in setup.py (see entry_points).

Run the tests regularly:

$ pytest hydxlib --cov

The code is linted automatically on each PR. To enable autoformatting locally, install pre-commit:

$ pre-commit install

Changelog of hydxlib

1.7.4 (2025-05-26)

  • Fix importing connections without “identificatieknooppuntofverbinding” into channels (#53)

1.7.3 (2025-04-11)

  • Added SewerageType to lib.

1.7.2 (2025-03-18)

  • Set minimum threedi-schema version of 0.300.18 instead of hard pin.

1.7.1 (2025-03-17)

  • Skip adding pumps when node start and end are identical

1.7.0 (2025-03-12)

  • Support schema 300

  • Drop json export

1.6.0 (2025-01-29)

  • Drop support for Python 3.7 and 3.8.

  • Add support for Python 3.12 and 3.13.

1.5.3 (2024-11-11)

  • Added check whether outlet code exists in connection nodes.

1.5.2 (2024-03-21)

  • Build the release with the build package instead of setuptools.

  • Rewrite release workflow to use a supported github action for github release.

  • Updated required threedi-schema version to 0.219.*

1.5.1 (2023-05-17)

  • Updated required threedi-schema version to 0.217.*

1.5.0 (2023-04-12)

  • Extra release to signal updated requirements.

1.4.5 (2023-03-31)

  • Make exporter work with SQLAlchemy 2.*

  • Updated required threedi-schema version to 0.216.*

1.4.4 (2023-02-20)

  • Fix error for missing “VerloopVolume” (VER_VOL).

1.4.3 (2023-02-01)

  • Fixed packaging (hydxlib was not listed as package in setup).

1.4.2 (2023-02-01)

  • Updated required threedi-schema version to 0.214.*

1.4.1 (2023-01-31)

  • Updated strictly required threedi-schema version to 0.214.3

1.4 (2023-01-27)

  • Added threedi-schema as a dependency, removing threedi-modelchecker

  • Fixed writing logging to file

1.3 (2022-12-12)

  • Fixed all tabulated profiles (TAB, HEU, MVR, UVR, OVA) and added TPZ and YZP.

  • Added inverted egg (EIG) profile.

  • Added trapezium profile in case no tabulated profile is given.

  • Add all cross sections to the 3Di spatialite and use the identifications from the input file.

  • Check if a profile is open/closed depending on the verbinding type (OPL or not).

1.2 (2022-12-06)

  • Added Heul (HEU), U-Vorm (UVR), Ovaal (OVA) profielen, fixed Muil (MVR), removed trapezium (TPZ).

  • Fixed empty connection_node.the_geom column.

1.1 (2022-11-09)

  • Log through the hydxlib.* logger instead of the root logger.

  • Emit error log if a value is required according to GWSW, but missing.

  • Made log messages more comprehensible by using terminology from GWSW instead of internal model and field names.

  • Set KNP_MAT to not required.

  • Emit more comprehensible error if a verbinding with types GSL, OPL, ITR, or DRL has no profile.

1.0 (2022-10-25)

  • Backport changes from https://github.com/threedi/beta-plugins.

  • Added threedi-modelchecker as a dependency, and used the 3Di schema in it as a replacement for hydxlib.sql_models.

  • Removed PostGRES support (only spatialite remains).

  • Replaced GDAL with pyproj.

  • An ‘RHK’ profile is now interpreted as a closed (instead of open) rectangle.

  • Add JSON export format.

0.7 (2020-03-03)

  • Closing database connection

  • Updating bug in rectangular cross sections

0.6 (2019-11-22)

  • Using the final version of the hydx format.

0.5 (2019-02-12)

  • Bug fix discharge coefficient orifices in Threedi.

0.4 (2019-01-18)

  • Small fixes.

0.3 (2019-01-09)

  • Added docstrings and updated the readme.

0.2 (2019-01-09)

  • Enabled automatic pypi.org uploads from travis-ci.com

0.1 (2019-01-09)

Project details


Download files

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

Source Distribution

hydxlib-1.7.4.tar.gz (27.7 kB view details)

Uploaded Source

Built Distribution

hydxlib-1.7.4-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

Details for the file hydxlib-1.7.4.tar.gz.

File metadata

  • Download URL: hydxlib-1.7.4.tar.gz
  • Upload date:
  • Size: 27.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hydxlib-1.7.4.tar.gz
Algorithm Hash digest
SHA256 dce15396ed4024f339d79726bdf2dedb52628e09bf9e393be90296d00083ec9f
MD5 e6794567713b59a1ebcb8896e098d4ae
BLAKE2b-256 8b7cd8bebc44980a2b351c9f4199f25c0ffe48f37c8b011adab87de77ab457bc

See more details on using hashes here.

File details

Details for the file hydxlib-1.7.4-py3-none-any.whl.

File metadata

  • Download URL: hydxlib-1.7.4-py3-none-any.whl
  • Upload date:
  • Size: 28.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for hydxlib-1.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 aabe842587e132caba7c04bd774fdc8476d73c6f5da1829f39e48ade8a490b5a
MD5 61ed003a60d1cb6cfc43af4212d2350f
BLAKE2b-256 b30296b67cd400a6f2e0f38ba5010035ddbbb34ea0fce2abc448a092f0d271db

See more details on using hashes here.

Supported by

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