threedi-modelchecker 2.6.2.dev0__tar.gz → 2.6.3__tar.gz

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3}/CHANGES.rst

@@ -2,10 +2,18 @@ Changelog of threedi-modelchecker
 =================================
 
 
-2.6.2 (unreleased)
+2.6.3 (2024-04-22)
 ------------------
 
-- Nothing changed yet.
+- Fix bug with check 183
+
+
+2.6.2 (2024-02-29)
+------------------
+
+- Add warning check (0616) for surfaces for which no inflow is generated because of the surface table not being referred to in global settings.
+- Add warning check (0617) to warn if the surface table referred to in global settings is empty and no inflow will be generated for it.
+- Remove warning check 0029.
 
 
 2.6.1 (2024-02-20)

{threedi-modelchecker-2.6.2.dev0/threedi_modelchecker.egg-info → threedi_modelchecker-2.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: threedi-modelchecker
-Version: 2.6.2.dev0
+Version: 2.6.3
 Summary: Checks validity of a 3Di schematisation
 Author-email: Nelen & Schuurmans <info@nelen-schuurmans.nl>
 License: MIT

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3}/threedi_modelchecker/__init__.py

@@ -1,5 +1,5 @@
 from .model_checks import *  # NOQA
 
 # fmt: off
-__version__ = '2.6.2.dev0'
+__version__ = '2.6.3'
 # fmt: on

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3}/threedi_modelchecker/checks/base.py

@@ -221,8 +221,7 @@ class TypeCheck(BaseCheck):
         self.expected_types = _sqlalchemy_to_sqlite_types(self.column.type)
 
     def get_invalid(self, session):
-        if ("sqlite" not in session.bind.dialect.dialect_description) and (
-                "geopackage" not in session.bind.dialect.dialect_description):
+        if "sqlite" not in session.bind.dialect.dialect_description:
             return []
         q_invalid = self.to_check(session)
         invalid_type_query = q_invalid.filter(
@@ -312,7 +311,7 @@ class GeometryTypeCheck(BaseCheck):
 def _get_geometry_type(column, dialect):
     if column.type.geometry_type == "GEOMETRY":
         return  # should skip the check
-    if dialect in ["sqlite", "geopackage"]:
+    if dialect == "sqlite":
         return column.type.geometry_type
     elif dialect == "postgresql":
         geom_type = column.type.geometry_type.capitalize()

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3}/threedi_modelchecker/checks/cross_section_definitions.py

@@ -505,86 +505,6 @@ class OpenIncreasingCrossSectionConveyanceFrictionCheck(CrossSectionBaseCheck):
         )
 
 
-class CrossSectionConveyanceFrictionAdviceCheck(CrossSectionBaseCheck):
-    """
-    Check if cross sections:
-    - Are of shape tabulated rectangle, tabulated trapezium, or tabulated YZ
-    - Monotonically increase in width
-    but do not use the new friction type with conveyance.
-    If so, advise the user that they may wish to use a friction type with conveyance.
-    """
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(column=models.CrossSectionLocation.id, *args, **kwargs)
-
-    def get_invalid(self, session):
-        invalids = []
-        for record in session.execute(
-            select(
-                models.CrossSectionLocation.id,
-                models.CrossSectionLocation.friction_type,
-                models.CrossSectionDefinition.shape,
-                models.CrossSectionDefinition.width,
-                models.CrossSectionDefinition.height,
-            )
-            .join(models.CrossSectionDefinition, isouter=True)
-            .where(
-                (models.CrossSectionDefinition.width != None)
-                & (models.CrossSectionDefinition.width != "")
-            )
-        ):
-            try:
-                widths = [float(x) for x in record.width.split(" ")]
-                heights = (
-                    [float(x) for x in record.height.split(" ")]
-                    if record.height not in [None, ""]
-                    else []
-                )
-            except ValueError:
-                continue  # other check catches this
-
-            _, _, configuration = cross_section_configuration(
-                shape=record.shape.value, heights=heights, widths=widths
-            )
-
-            if (
-                configuration == "open"
-                and (
-                    len(widths) > 1
-                    and all(
-                        next_width >= previous_width
-                        for (previous_width, next_width) in zip(widths[:-1], widths[1:])
-                    )
-                )
-                and (
-                    record.shape.value
-                    in [
-                        constants.CrossSectionShape.TABULATED_RECTANGLE.value,
-                        constants.CrossSectionShape.TABULATED_TRAPEZIUM.value,
-                        constants.CrossSectionShape.TABULATED_YZ.value,
-                    ]
-                )
-                and (
-                    record.friction_type.value
-                    not in [
-                        constants.FrictionType.CHEZY_CONVEYANCE.value,
-                        constants.FrictionType.MANNING_CONVEYANCE.value,
-                    ]
-                )
-            ):
-                invalids.append(record)
-
-        return invalids
-
-    def description(self):
-        return (
-            "Friction for this cross-section will be calculated without conveyance. "
-            "For open Tabulated or YZ cross-sections, using conveyance in the calculation "
-            "of friction is recommended in case there is a significant variation "
-            "of the bed level (for instance, in a scenario with overflowing floodplains)."
-        )
-
-
 class CrossSectionVariableCorrectLengthCheck(CrossSectionBaseCheck):
     """Variable friction and vegetation properties should contain 1 value for each element; len(var_property) = len(width)-1"""
 

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3}/threedi_modelchecker/checks/other.py

@@ -815,6 +815,28 @@ class PerviousNodeInflowAreaCheck(BaseCheck):
         return f"{self.column_name} has a an associated inflow area larger than 10000 m2; this might be an error."
 
 
+class InflowNoFeaturesCheck(BaseCheck):
+    """Check that the surface table in the global use_0d_inflow setting contains at least 1 feature."""
+
+    def __init__(self, *args, surface_table, condition=True, **kwargs):
+        super().__init__(*args, column=models.GlobalSetting.id, **kwargs)
+        self.surface_table = surface_table
+        self.condition = condition
+
+    def get_invalid(self, session: Session):
+        surface_table_length = session.execute(
+            select(func.count(self.surface_table.id))
+        ).scalar()
+        return (
+            session.query(models.GlobalSetting)
+            .filter(self.condition, surface_table_length == 0)
+            .all()
+        )
+
+    def description(self) -> str:
+        return f"v2_global_settings.use_0d_inflow is set to use {self.surface_table.__tablename__}, but {self.surface_table.__tablename__} does not contain any features."
+
+
 class NodeSurfaceConnectionsCheck(BaseCheck):
     """Check that no more than 50 surfaces are mapped to a connection node"""
 

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3}/threedi_modelchecker/config.py

@@ -17,7 +17,6 @@ from .checks.base import (
     UniqueCheck,
 )
 from .checks.cross_section_definitions import (
-    CrossSectionConveyanceFrictionAdviceCheck,
     CrossSectionEqualElementsCheck,
     CrossSectionExpectEmptyCheck,
     CrossSectionFirstElementNonZeroCheck,
@@ -61,6 +60,7 @@ from .checks.other import (
     DefinedAreaCheck,
     FeatureClosedCrossSectionCheck,
     ImperviousNodeInflowAreaCheck,
+    InflowNoFeaturesCheck,
     LinestringLocationCheck,
     NodeSurfaceConnectionsCheck,
     OpenChannelsWithNestedNewton,
@@ -326,12 +326,6 @@ CHECKS += [
         error_code=28,
     )
 ]
-CHECKS += [
-    CrossSectionConveyanceFrictionAdviceCheck(
-        error_code=29,
-        level=CheckLevel.INFO,
-    )
-]
 
 ## 003x: CALCULATION TYPE
 
@@ -883,6 +877,16 @@ CHECKS += [
     LinestringLocationCheck(error_code=205, column=table.the_geom, max_distance=1)
     for table in [models.Channel, models.Culvert]
 ]
+CHECKS += [
+    QueryCheck(
+        error_code=206,
+        column=models.ConnectionNode.the_geom_linestring,
+        invalid=Query(models.ConnectionNode).filter(
+            models.ConnectionNode.the_geom_linestring != None
+        ),
+        message=f"{models.ConnectionNode.the_geom_linestring} must be NULL",
+    )
+]
 CHECKS += [
     SpatialIndexCheck(
         error_code=207, column=models.ConnectionNode.the_geom, level=CheckLevel.WARNING
@@ -2060,7 +2064,33 @@ CHECKS += [
         (models.ImperviousSurfaceMap.connection_node_id, models.ConnectionNode),
     )
 ]
+CHECKS += [
+    QueryCheck(
+        error_code=616,
+        level=CheckLevel.WARNING,
+        column=table.id,
+        filters=~CONDITIONS[condition].exists(),
+        invalid=Query(table),
+        message=f"No inflow will be generated for this feature, because v2_global_settings.use_0d_inflow is not set to use {table.__tablename__}.",
+    )
+    for table, condition in (
+        (models.ImperviousSurface, "0d_imp"),
+        (models.Surface, "0d_surf"),
+    )
+]
 
+CHECKS += [
+    InflowNoFeaturesCheck(
+        error_code=617,
+        level=CheckLevel.WARNING,
+        surface_table=table,
+        condition=CONDITIONS[condition].exists(),
+    )
+    for table, condition in (
+        (models.ImperviousSurface, "0d_imp"),
+        (models.Surface, "0d_surf"),
+    )
+]
 
 CHECKS += [
     RangeCheck(
@@ -2890,9 +2920,9 @@ CHECKS += [
         error_code=183,
         level=CheckLevel.WARNING,
         column=col_cross_section_location,
-        invalid=Query(models.CrossSectionDefinition)
+        invalid=Query(models.CrossSectionLocation)
         .join(
-            models.CrossSectionLocation,
+            models.CrossSectionDefinition,
             models.CrossSectionLocation.definition_id
             == models.CrossSectionDefinition.id,
         )

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3}/threedi_modelchecker/tests/conftest.py

@@ -20,8 +20,8 @@ def threedi_db(tmpdir_factory):
     https://factoryboy.readthedocs.io/en/latest/orms.html#managing-sessions
     """
     tmp_path = tmpdir_factory.mktemp("spatialite4")
-    tmp_sqlite = tmp_path / "empty.gpkg"
-    shutil.copyfile(data_dir / "empty.gpkg", tmp_sqlite)
+    tmp_sqlite = tmp_path / "empty_v4.sqlite"
+    shutil.copyfile(data_dir / "empty_v4.sqlite", tmp_sqlite)
     db = ThreediDatabase(tmp_sqlite)
     schema = ModelSchema(db)
     schema.upgrade(backup=False, upgrade_spatialite_version=False)
@@ -52,10 +52,7 @@ def session(threedi_db):
 
 @pytest.fixture
 def empty_sqlite_v4(tmp_path):
-    """An function-scoped empty geopackage v4 in the latest migration state"""
-    tmp_sqlite = tmp_path / "empty.gpkg"
-    shutil.copyfile(data_dir / "empty.gpkg", tmp_sqlite)
+    """An function-scoped empty spatialite v4 in the latest migration state"""
+    tmp_sqlite = tmp_path / "empty_v4.sqlite"
+    shutil.copyfile(data_dir / "empty_v4.sqlite", tmp_sqlite)
     return ThreediDatabase(tmp_sqlite)
-
-
-

threedi_modelchecker-2.6.3/threedi_modelchecker/tests/data/empty_v4.sqlite

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1157e95b7271dbe14142f96bc46664be92f53d463726c4d0cb18be07f9cd7acb
+size 6086656

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3}/threedi_modelchecker/tests/test_checks_cross_section_definitions.py

@@ -2,7 +2,6 @@ import pytest
 from threedi_schema import constants, models
 
 from threedi_modelchecker.checks.cross_section_definitions import (
-    CrossSectionConveyanceFrictionAdviceCheck,
     CrossSectionEqualElementsCheck,
     CrossSectionExpectEmptyCheck,
     CrossSectionFirstElementNonZeroCheck,
@@ -575,120 +574,6 @@ def test_check_cross_section_increasing_open_with_conveyance_friction(
     assert len(invalid_rows) == expected_result
 
 
-@pytest.mark.parametrize(
-    "shape,width,height,expected_result",
-    [
-        (0, "0.1", "0.2", 0),  # closed rectangle, pass
-        (1, "0.1", None, 0),  # open rectangle, pass because it isn't tabulated
-        (
-            5,
-            "0.04 0.1",
-            "0.06 0.2",
-            1,
-        ),  # open tabulated rectangle, increasing width, fail
-        (
-            5,
-            "0.04 0.1 0.1",
-            "0.06 0.2 0.3",
-            1,
-        ),  # open tabulated rectangle, equal width segments, fail
-        (
-            5,
-            "0.2 0.1",
-            "0.06 0.2",
-            0,
-        ),  # open tabulated rectangle, decreasing width, pass
-        (
-            5,
-            "0.04 0.1 0",
-            "0.06 0.2",
-            0,
-        ),  # closed tabulated rectangle, pass
-        (
-            6,
-            "0.04 0.1",
-            "0.06 0.2",
-            1,
-        ),  # open tabulated trapezium, increasing width, fail
-        (
-            6,
-            "0.04 0.1 0.1",
-            "0.06 0.2 0.3",
-            1,
-        ),  # open tabulated trapezium, equal width segments, fail
-        (
-            6,
-            "0.2 0.1",
-            "0.06 0.3",
-            0,
-        ),  # open tabulated trapezium, decreasing width, pass
-        (
-            6,
-            "0.04 0.1 0",
-            "0.06 0.2",
-            0,
-        ),  # closed tabulated trapezium, pass
-        (
-            7,
-            "0.01 0.11",
-            "0.11 0.21",
-            1,
-        ),  # open tabulated yz, increasing width, fail
-        (
-            7,
-            "0.01 0.10 0.10",
-            "0.11 0.21 0.31",
-            1,
-        ),  # open tabulated yz, equal width segments, fail
-        (
-            7,
-            "0.11 0.01",
-            "0.11 0.20",
-            0,
-        ),  # open tabulated yz, decreasing width, pass
-        (
-            7,
-            "0.01 0.11 0.01",
-            "0.11 0.21 0.11",
-            0,
-        ),  # closed tabulated yz,  pass
-        (0, "foo", "", 0),  # bad data, pass
-    ],
-)
-@pytest.mark.parametrize(
-    "friction_type,conveyance",
-    [
-        (constants.FrictionType.CHEZY, False),
-        (constants.FrictionType.MANNING, False),
-        (constants.FrictionType.CHEZY_CONVEYANCE, True),
-        (constants.FrictionType.MANNING_CONVEYANCE, True),
-    ],
-)
-def test_check_cross_section_conveyance_friction_info_message(
-    session, shape, width, height, expected_result, friction_type, conveyance
-):
-    """
-    When a cross-section is expected to fail, that means
-    it may use friction with conveyance, but isn't, so an
-    info message will be given to inform the user of that.
-    """
-    definition = factories.CrossSectionDefinitionFactory(
-        shape=shape,
-        width=width,
-        height=height,
-    )
-    factories.CrossSectionLocationFactory(
-        definition=definition, friction_type=friction_type
-    )
-    check = CrossSectionConveyanceFrictionAdviceCheck()
-    # this check should pass on cross-section locations which use conveyance,
-    # regardless of their other parameters
-    if conveyance:
-        expected_result = 0
-    invalid_rows = check.get_invalid(session)
-    assert len(invalid_rows) == expected_result
-
-
 @pytest.mark.parametrize("data, result", [["1 2", True], ["1 2 3", False]])
 def test_check_correct_length(session, data, result):
     definition = factories.CrossSectionDefinitionFactory(

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3}/threedi_modelchecker/tests/test_checks_factories.py

@@ -36,7 +36,7 @@ def test_gen_not_null_checks():
 def test_gen_geometry_check():
     geometry_checks = generate_geometry_checks(models.ConnectionNode.__table__)
 
-    assert len(geometry_checks) == 1
+    assert len(geometry_checks) == 2
     geometry_check_columns = [check.column for check in geometry_checks]
     assert models.ConnectionNode.the_geom in geometry_check_columns
 

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3}/threedi_modelchecker/tests/test_checks_other.py

@@ -20,6 +20,7 @@ from threedi_modelchecker.checks.other import (
     DefinedAreaCheck,
     FeatureClosedCrossSectionCheck,
     ImperviousNodeInflowAreaCheck,
+    InflowNoFeaturesCheck,
     LinestringLocationCheck,
     NodeSurfaceConnectionsCheck,
     OpenChannelsWithNestedNewton,
@@ -549,6 +550,46 @@ def test_impervious_connection_node_inflow_area(session, value, expected_result)
     assert len(invalid) == expected_result
 
 
+@pytest.mark.parametrize(
+    "surface_number,expected_result",
+    [
+        (0, 1),
+        (1, 0),
+        (10, 0),
+    ],
+)
+def test_inflow_no_features_impervious(session, surface_number, expected_result):
+    # add fields
+    factories.GlobalSettingsFactory()
+    if surface_number > 0:
+        factories.ImperviousSurfaceFactory.create_batch(size=surface_number)
+
+    # test
+    check = InflowNoFeaturesCheck(surface_table=models.ImperviousSurface)
+    invalid = check.get_invalid(session)
+    assert len(invalid) == expected_result
+
+
+@pytest.mark.parametrize(
+    "surface_number,expected_result",
+    [
+        (0, 1),
+        (1, 0),
+        (10, 0),
+    ],
+)
+def test_inflow_no_features_pervious(session, surface_number, expected_result):
+    # add fields
+    factories.GlobalSettingsFactory()
+    if surface_number > 0:
+        factories.SurfaceFactory.create_batch(size=surface_number)
+
+    # test
+    check = InflowNoFeaturesCheck(surface_table=models.Surface)
+    invalid = check.get_invalid(session)
+    assert len(invalid) == expected_result
+
+
 @pytest.mark.parametrize(
     "value,expected_result",
     [

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3/threedi_modelchecker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: threedi-modelchecker
-Version: 2.6.2.dev0
+Version: 2.6.3
 Summary: Checks validity of a 3Di schematisation
 Author-email: Nelen & Schuurmans <info@nelen-schuurmans.nl>
 License: MIT

{threedi-modelchecker-2.6.2.dev0 → threedi_modelchecker-2.6.3}/threedi_modelchecker.egg-info/SOURCES.txt

@@ -38,4 +38,4 @@ threedi_modelchecker/tests/test_checks_timeseries.py
 threedi_modelchecker/tests/test_exporters.py
 threedi_modelchecker/tests/test_model_checks.py
 threedi_modelchecker/tests/data/__init__.py
-threedi_modelchecker/tests/data/empty.gpkg
+threedi_modelchecker/tests/data/empty_v4.sqlite