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.org/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.
Project details
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.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a94b327e64a84a07ef39915f52e27b39e6da53a54be245de2d75f609e51a96ac |
|
MD5 | d2a06d85ad7c02cab9c39e027933aa92 |
|
BLAKE2b-256 | 2c897d9781998de93f49c069ea52593c359eccf1756138b56f8ab7ab6a43be48 |
Hashes for threedi_modelchecker-2.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19b235a49e03fb4b32ad9678367e83d03f397b8adf9eb23b97db3e23a22db719 |
|
MD5 | abb0f907f070cb1cfee626ff3a3bd13e |
|
BLAKE2b-256 | f21778af9c04d69a3a879b53e6d7ca0c5c5c32f742b70d0f4d2ecd0c8194c565 |