threedi-modelchecker 2.18.23

Checks validity of a 3Di schematisation

A tool to verify the correctness of a Rana HCC schematisation.

It asserts the correctness of a HCC schematisation and provides detailed information about any potential errors in it.

This package only works against a specific schematisation version. Use https://pypi.org/project/threedi-schema/ to upgrade a schematisation version. See also the Rana documentation at https://docs.ranawaterintelligence.com/b_modelling_workflow.html.

Note that the name “modelchecker” might be slightly confusing: the thing that is checked is a schematisation, and not a (computational) model. A schematisation is built interactively by the user and this schematisation will later be converted to a 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 Rana Results Analysis Qgis plugin: https://github.com/nens/threedi-results-analysis.

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

Virtual environment

Create a virtual environment. First install the native system GDAL library:

sudo apt install libgdal-dev

Then set up a virtual environment.

python -m venv venv source venv/bin/activate pip install -e “.[test,rasterio]” pip install GDAL==$(gdal-config –version) –no-build-isolation –no-cache-dir –force-reinstall

Test your virtual environment by running the tests:

pytest

Container

A docker image has been created for easy development. It contains a 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 HCC model schematisation.

Release

Make sure you have zestreleaser installed.

fullrelease

When you created a tag, make sure to upload it to pypi.