hydamo-validation 1.3.1__tar.gz → 1.4.0__tar.gz

{hydamo_validation-1.3.1 → hydamo_validation-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hydamo_validation
-Version: 1.3.1
+Version: 1.4.0
 Summary: Validation module for HyDAMO data
 Author-email: Daniel Tollenaar <daniel@d2hydro.nl>
 License: MIT
@@ -57,11 +57,38 @@ Download or clone the repository. Now simply install the module in the activated
 pip install .
 ```
 
-## Run an example
-A working example with data can be found in `notebooks/test_wrij.ipynb`. In the activated environment launch jupyter notebook by:
+## Run in Python
 
+### Specify a coverage directory
+To get the validator running you need some AHN data. You can find these in the [data directory](https://github.com/HetWaterschapshuis/HyDAMOValidatieModule/tree/ee9ea1efed385deb692b89057e9c97114fd8c3be/tests/data/dtm) of this directory. We assume you copy this to `your/local/ahn/dir`. Now specify your coverage and init the validator in a python-script:
+
+```
+from hydamo_validation import validator
+from pathlib import Path
+
+coverage = {"AHN": Path("your/local/ahn/dir")}
+
+hydamo_validator = validator(
+    output_types=["geopackage", "csv", "geojson"], coverages=coverage, log_level="INFO"
+)
+
+```
+
+With this validator you can validate a directory that directory should have the following structure. The name of `datasets` directory and `ValidatorRules.json` are mandatory. Within datasets you can put one or more geopackages with `HyDAMO` layers.
+
+```
+your/directory/
+├─ datasets/
+│  ├─ hydamo.gpkg
+├─ ValidationRules.json
 ```
-jupyter notebook
+
+Now you can validate the `HyDAMO` layers inside `your/ directory` by:
 ```
 
-Select `test_wrij.ipynb` read and run it.
+directory = Path("your/directory")
+
+datamodel, layer_summary, result_summary = hydamo_validator(
+    directory=directory, raise_error=False
+)
+```

hydamo_validation-1.4.0/README.md

@@ -0,0 +1,75 @@
+# The HyDAMO Validation Module: hydamo_validation
+
+Validation Module for HyDAMO data.
+
+## Installation
+
+### Python installation
+Make sure you have an Miniconda or Anaconda installation. You can download these here:
+ - https://www.anaconda.com/products/individual
+ - https://docs.conda.io/en/latest/miniconda.html
+
+During installation, tick the box "Add Anaconda to PATH", ignore the red remarks
+
+### Create the `validatietool` environment
+Use the `env/environment.yml` in the repository to create the conda environment: `validatietool`
+
+```
+conda env create -f environment.yml
+```
+
+After installation you can activate your environment in command prompt
+
+```
+conda activate validatietool
+```
+
+### Install hydamo_validation
+Simply install the module in the activated environment:
+
+```
+pip install hydamo_validation
+```
+
+### Develop-install hydamo_validation
+Download or clone the repository. Now simply install the module in the activated environment:
+
+```
+pip install .
+```
+
+## Run in Python
+
+### Specify a coverage directory
+To get the validator running you need some AHN data. You can find these in the [data directory](https://github.com/HetWaterschapshuis/HyDAMOValidatieModule/tree/ee9ea1efed385deb692b89057e9c97114fd8c3be/tests/data/dtm) of this directory. We assume you copy this to `your/local/ahn/dir`. Now specify your coverage and init the validator in a python-script:
+
+```
+from hydamo_validation import validator
+from pathlib import Path
+
+coverage = {"AHN": Path("your/local/ahn/dir")}
+
+hydamo_validator = validator(
+    output_types=["geopackage", "csv", "geojson"], coverages=coverage, log_level="INFO"
+)
+
+```
+
+With this validator you can validate a directory that directory should have the following structure. The name of `datasets` directory and `ValidatorRules.json` are mandatory. Within datasets you can put one or more geopackages with `HyDAMO` layers.
+
+```
+your/directory/
+├─ datasets/
+│  ├─ hydamo.gpkg
+├─ ValidationRules.json
+```
+
+Now you can validate the `HyDAMO` layers inside `your/ directory` by:
+```
+
+directory = Path("your/directory")
+
+datamodel, layer_summary, result_summary = hydamo_validator(
+    directory=directory, raise_error=False
+)
+```

{hydamo_validation-1.3.1 → hydamo_validation-1.4.0}/hydamo_validation/__init__.py

@@ -1,7 +1,7 @@
 __author__ = ["Het Waterschapshuis", "D2HYDRO", "HKV", "HydroConsult"]
 __copyright__ = "Copyright 2021, HyDAMO ValidatieTool"
 __credits__ = ["D2HYDRO", "HKV", "HydroConsult"]
-__version__ = "1.3.1"
+__version__ = "1.4.0"
 
 __license__ = "MIT"
 __maintainer__ = "Daniel Tollenaar"

{hydamo_validation-1.3.1 → hydamo_validation-1.4.0}/hydamo_validation/functions/topologic.py

@@ -4,6 +4,7 @@ from typing import Literal
 import geopandas as gpd
 import pandas as pd
 from shapely.geometry import Point
+from hydamo_validation import geometry
 
 """ 
 In this block we define supporting functions. Supporting functions are ignored
@@ -364,7 +365,9 @@ def snaps_to_hydroobject(gdf, datamodel, method, tolerance=0.001, dtype=bool):
     """
 
     branches = datamodel.hydroobject
-    gdf.snap_to_branch(branches, snap_method=method, maxdist=tolerance)
+    geometry.find_nearest_branch(
+        branches=branches, geometries=gdf, method=method, maxdist=tolerance
+    )
     series = ~gdf.branch_offset.isna()
     return series.astype(dtype)
 
@@ -651,12 +654,15 @@ def compare_longitudinal(
         Default dtype is bool
 
     """
+    branches = datamodel.hydroobject
     compare_gdf = getattr(datamodel, compare_object)
 
     # snap layers to to branches
-    compare_gdf.snap_to_branch(datamodel.hydroobject, snap_method="overall")
-    gdf.snap_to_branch(datamodel.hydroobject, snap_method="overall")
+    geometry.find_nearest_branch(
+        branches=branches, geometries=compare_gdf, method="overall"
+    )
 
+    geometry.find_nearest_branch(branches=branches, geometries=gdf, method="overall")
     return gdf.apply(
         lambda x: _compare_longitudinal(
             x, parameter, compare_gdf, compare_parameter, direction, logical_operator

{hydamo_validation-1.3.1 → hydamo_validation-1.4.0}/hydamo_validation/logical_validation.py

@@ -129,7 +129,7 @@ def execute(
         if i["object"] in datamodel.data_layers
     ]
     logger.info(
-        rf"lagen met valide objecten en regels: {[i["object"] for i in object_rules_sets]}"
+        rf"lagen met valide objecten en regels: {[i['object'] for i in object_rules_sets]}"
     )
     for object_rules in object_rules_sets:
         col_translation: dict = {}
@@ -280,7 +280,10 @@ def execute(
                     hasattr(datamodel, "hydroobject")
                 ):
                     result_series = _process_topologic_function(
-                        getattr(datamodel, object_layer),
+                        # getattr(
+                        #     datamodel, object_layer
+                        # ),  # FIXME: commented as we need to apply filter in topologic functions as well. Remove after tests pass
+                        object_gdf,
                         datamodel,
                         function,
                         input_variables,