Checks validity of a 3Di schematisation
Project description
A tool to verify the correctness of a 3Di schematisation.
It asserts the correctness of a 3Di schematisation and provides detailed information about any potential errors in it.
This package only work against a specific schematisation version. Use https://pypi-hypernode.com/project/threedi-schema/ to upgrade a schematisation version. See also the 3Di documentation at https://docs.3di.lizard.net/en/stable/d_before_you_begin.html#database-overview
Note that the name “modelchecker” might be slightly confusing: the thing that is checked is a schematisation, and not a threedimodel. A schematisation is built interactively by the user and this schematisation will be converted to a 3Di-Model which can be used in simulations.
Installation
pip install threedi-modelchecker
Note that raster checks will be skipped unless GDAL is available. threedi-modelchecker is also integrated into the ThreediToolbox Qgis plugin: https://github.com/nens/ThreeDiToolbox
Example
The following code sample shows how you can use the modelchecker to run all configured checks and print an overview of all discovered errors:
from threedi_modelchecker.exporters import format_check_results
from threedi_modelchecker import ThreediModelChecker
from threedi_schema import ThreediDatabase
sqlite_file = "<Path to your sqlite file>"
database = ThreediDatabase(sqlite_file)
model_checker = ThreediModelChecker(database)
for check, error in model_checker.errors(level="WARNING"):
print(format_check_results(check, error))
Command-line interface
Use the modelchecker from the command line as follows:
threedi_modelchecker check -s path/to/model.sqlite -l warning
By default, WARNING and INFO checks are ignored. To skip the beta features check, add the –allow-beta flag.
Development
A docker image has been created for easy development. It contains an postgis server with an empty 3Di database to allow for easy testing.
Build the image:
docker-compose build
Run the tests:
docker-compose run modelchecker pytest
See Creating revisions for instructions on how to change the 3Di model schematisation.
Release
Make sure you have zestreleaser installed.
fullrelease
When you created a tag, make sure to upload it to pypi.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for threedi-modelchecker-2.5.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e558e62747beb7037d9566ec774e8f4a38eb8ef8e062748d36de05f79dcbecac |
|
| MD5 | 13c60992f6062dcc30bd77634eb87718 |
|
| BLAKE2b-256 | 638a8d3002d48534fcbef36a4330b7e57b23a393d0ce37f92e8db32900c112e5 |
Hashes for threedi_modelchecker-2.5.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d75efb2d8c389c5ef24247d8c56a4c601ad54a15b84b2c29ddb5bbb6f0c6d31a |
|
| MD5 | 44854ed50dedb0f7fe601ad76e5776b3 |
|
| BLAKE2b-256 | 668f80bc3d76bcb8052243ebb18df92cd132c440cf2367e4a015297120b98593 |
