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 -s path/to/model.sqlite check -l warning
By default, WARNING and INFO checks are ignored.
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.0.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0291fc222c679250ed0ab2e786807394d04f9bec41f827f8eae71ef7356a1c67 |
|
| MD5 | bdc8682e5d6b5df35592e680d781d194 |
|
| BLAKE2b-256 | 7b6099a69e4ec75a972b1fab44f9fea9d409ba67a9c2fa50fd5909486a837941 |
Hashes for threedi_modelchecker-2.0.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | dd8f6df43f3b24e8dd6f8af4b062ca320ff15f8038b104f44d79293056889025 |
|
| MD5 | 3a60524cdd80cf8fd6503d7b2c1835bb |
|
| BLAKE2b-256 | 2e2f452cd9bf4d3ebc796c5e08d75e98fc372dfbc0c404a6c1ffcf1b2f5d8452 |
