Checks validity of a 3Di schematisation
Project description
Threedi-modelchecker is a tool to verify the correctness of a 3Di schematisation. The goal is to provide a tool for builders to quickly check if his/her schematisation is correct and can be converted to a 3Di-Model to run a 3Di simulation. It provides detailed information about any potential errors in the schematisation.
Threedi-modelchecks only work against the latest 3Di migration: https://docs.3di.lizard.net/en/stable/d_before_you_begin.html#database-overview
Note:
In 2021 we changed the naming within the 3Di realm. To better understand what users meant with ‘model’ we made a clear distinction between a schematisation and a model. A schematisation is built interactively by the user and this schematisation will be converted to a 3Di-Model which can be used in simulations. This repo is still called the threedi-modelchecker which might lead to confusion.
Installation:
pip install threedi-modelchecker
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_modelchecker 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.
Migrations
Migrate the schematisation file to the latest version as follows:
threedi_modelchecker -s path/to/model.sqlite migrate
The file will be change in-place.
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-0.35.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fac412cc29c63c0c2f7deff6f23873fe75872f95e4fc0696bbbdc21dd4fdfdee |
|
| MD5 | e91a5ac0b4d3a6635611266cb1808ecd |
|
| BLAKE2b-256 | 811c46a3e3ed8ddc98a6c2c91298d20cf30be464e58c91453a56843b46806719 |
Hashes for threedi_modelchecker-0.35.1-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7dfaf6cf0a723448bd2c3307cf00506172fc3039d614a95c1cc73d2729bf2e7f |
|
| MD5 | 7d8bb61eb93d4d1b57cc734db8029a61 |
|
| BLAKE2b-256 | 033639f8a98f14df2e8df8fb7a80d0efe9f9ea5d734d858f0edb449087b6c96a |
