hydamo-validation 1.4.1__tar.gz

hydamo_validation-1.4.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 HyDAMO ValidatieTool
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

hydamo_validation-1.4.1/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.1
+Name: hydamo_validation
+Version: 1.4.1
+Summary: Validation module for HyDAMO data
+Author-email: Daniel Tollenaar <daniel@d2hydro.nl>
+License: MIT
+Project-URL: Source, https://github.com/HetWaterschapshuis/HyDAMOValidatieModule
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: geopandas
+Requires-Dist: pandas>=2
+Requires-Dist: pyogrio
+Requires-Dist: rasterio
+Requires-Dist: shapely>=2
+Requires-Dist: rasterstats
+Provides-Extra: tests
+Requires-Dist: pytest; extra == "tests"
+
+# 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.4.1/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.4.1/hydamo_validation/__init__.py

@@ -0,0 +1,23 @@
+__author__ = ["Het Waterschapshuis", "D2HYDRO", "HKV", "HydroConsult"]
+__copyright__ = "Copyright 2021, HyDAMO ValidatieTool"
+__credits__ = ["D2HYDRO", "HKV", "HydroConsult"]
+__version__ = "1.4.1"
+
+__license__ = "MIT"
+__maintainer__ = "Daniel Tollenaar"
+__email__ = "daniel@d2hydro.nl"
+
+import fiona  # top-level import to avoid fiona import issue: https://github.com/conda-forge/fiona-feedstock/issues/213
+from hydamo_validation.functions import topologic as topologic_functions
+from hydamo_validation.functions import logic as logic_functions
+from hydamo_validation.functions import general as general_functions
+from hydamo_validation.validator import validator
+
+__all__ = [
+    "fiona",
+    "topologic_functions",
+    "logic_functions",
+    "general_functions",
+    "validator",
+    "SCHEMAS_PATH",
+]