This release is a pre-release and may not be stable for production use.
threedi-modelchecker
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.org/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.
Metadata
Release files for threedi-modelchecker 2.10.0.dev3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| threedi_modelchecker-2.10.0.dev3.tar.gz | 620.7 kB | Without provenance | Details for threedi_modelchecker-2.10.0.dev3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| threedi_modelchecker-2.10.0.dev3-py3-none-any.whl | Python 3 | none | any | Details for threedi_modelchecker-2.10.0.dev3-py3-none-any.whl |
Total release size: 1.2 MB
Release files / threedi_modelchecker-2.10.0.dev3.tar.gz
| Download URL | threedi_modelchecker-2.10.0.dev3.tar.gz |
|---|---|
| Size | 620.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
053981e2f1e4ee6065c49ae0cf05130682ca73424e99d2a223b266da4e4f7779
|
|
BLAKE2b-256 checksum How to use checksums |
ac5c1421cb5f433a22d14c8dee4ca76316e709eb91ec53d27d2e7bbfbdf26774
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.12.5
|
Release files / threedi_modelchecker-2.10.0.dev3-py3-none-any.whl
| Download URL | threedi_modelchecker-2.10.0.dev3-py3-none-any.whl |
|---|---|
| Size | 628.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5bc6798624c228cf85a9899c7c152aa50c1521e9262ba1df065d75fda2a8e7b7
|
|
BLAKE2b-256 checksum How to use checksums |
6993980273bfc209a515189f235525eca85834339ecc61471895a52e8b06c202
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.0 CPython/3.12.5
|
Security for threedi-modelchecker 2.10.0.dev3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.