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.
5 maintainers
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file threedi_modelchecker-2.18.24.tar.gz.
File metadata
- Download URL: threedi_modelchecker-2.18.24.tar.gz
- Upload date:
- Size: 636.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6fc40ecd97eda79fd9e788ea26e4931ca4079714b4865648c1e012202c883c98
|
|
| MD5 |
cf87c75fc5bfa1621dad0cad87c90195
|
|
| BLAKE2b-256 |
d66e1344ea07c8982b80c2857fdd62f5c7b3a7cd6a6928b6756458d109054618
|
File details
Details for the file threedi_modelchecker-2.18.24-py3-none-any.whl.
File metadata
- Download URL: threedi_modelchecker-2.18.24-py3-none-any.whl
- Upload date:
- Size: 642.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a60bd13c359562245cbab0e76732f22705590146affe8a03f6b2a1660adec2af
|
|
| MD5 |
31c39e25d15bc95b35375bb1dbbca553
|
|
| BLAKE2b-256 |
3ee545050a9d56470ef05d3de6f22e7780019b0f4d700ab9fbb45a4b8ec6325b
|
