Skip to main content

Checks validity of a 3Di schematisation

Project description

https://img.shields.io/pypi/v/threedi-modelchecker.svg Github Actions status

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.

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

threedi_modelchecker-2.13.0.tar.gz (622.6 kB view details)

Uploaded Source

Built Distribution

threedi_modelchecker-2.13.0-py3-none-any.whl (630.0 kB view details)

Uploaded Python 3

File details

Details for the file threedi_modelchecker-2.13.0.tar.gz.

File metadata

  • Download URL: threedi_modelchecker-2.13.0.tar.gz
  • Upload date:
  • Size: 622.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for threedi_modelchecker-2.13.0.tar.gz
Algorithm Hash digest
SHA256 0fe741bb3f2b3059ad6bf4ec52fdfcfefd39d7bc5fbbfd85d35bb59f4a2f019c
MD5 1eb9b1b613c38a5e2c9525a91f3f0922
BLAKE2b-256 2e5d9f6b5a9d99b47dd689344f098e1f0a3d1257eca78ebb11215c58714da3dd

See more details on using hashes here.

File details

Details for the file threedi_modelchecker-2.13.0-py3-none-any.whl.

File metadata

File hashes

Hashes for threedi_modelchecker-2.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64200352eba6dba057d148493f10687565599c1982acb9b519638dac4c035601
MD5 1a35cb2cdb3ec9dc6c72bac52eb5ad84
BLAKE2b-256 7e0b1899875e9bb86535d2d80ae3e26a09cc99aaf0fb30eabcf660c4e2ab1916

See more details on using hashes here.

Supported by

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