py-pilecore 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

{py_pilecore-0.2.0.dist-info → py_pilecore-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-pilecore
-Version: 0.2.0
+Version: 0.2.2
 Summary: Public python SDK for the CEMS PileCore web-API.
 License: MIT License
         
@@ -33,7 +33,7 @@ Requires-Dist: pygef <1,>0.8
 Requires-Dist: numpy <2,>1
 Requires-Dist: pandas <3,>2
 Requires-Dist: cems-nuclei[client] <1,>0.3
-Requires-Dist: matplotlib <4,>3
+Requires-Dist: matplotlib <4,>=3.8
 Requires-Dist: tqdm[notebook] <5,>4
 Requires-Dist: natsort <9,>8
 Provides-Extra: docs
@@ -69,6 +69,7 @@ Public python SDK for the CEMS PileCore web-API
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Coverage Status](https://coveralls.io/repos/github/cemsbv/py-pilecore/badge.svg)](https://coveralls.io/github/cemsbv/py-pilecore)
 
 
 This repository is created by [CEMS BV](https://cemsbv.nl/) and is a public python wrapper around the CEMS [PileCore web-API](https://nuclei.cemsbv.io/#/pilecore/api).
@@ -96,7 +97,7 @@ Go to `personal-access-tokens` and create a new user token.
 
 ## Environment
 
-We recommend developing in Python3.9 with a clean virtual environment (using `virtualenv` or `conda`), installing the requirements from the requirements.txt file:
+We recommend developing in Python3.10 with a clean virtual environment (using `virtualenv` or `conda`), installing the requirements from the requirements.txt file:
 
 Example using `virtualenv` and `pip` to install the dependencies in a new environment .env on Linux:
 
@@ -148,7 +149,7 @@ coverage run -m pytest
 
 ## Requirements
 
-Requirements are autogenerated by the `pip-compile` command with python 3.9
+Requirements are autogenerated by the `pip-compile` command with python 3.10
 
 Install pip-tools with:
 

{py_pilecore-0.2.0.dist-info → py_pilecore-0.2.2.dist-info}/RECORD

@@ -1,23 +1,23 @@
 pypilecore/__init__.py,sha256=T2Uuao6fboVhrzKI_Sa7jXbcNAUl_PKk9BFdsozOG98,78
-pypilecore/_version.py,sha256=Sq1TwzS11voDnsLKeD0g5MLvt8OhQZLjzMiOXn0lYSQ,175
+pypilecore/_version.py,sha256=9aXcu_uSTZO0zKxzM74tTRCZnhqQ6xOalmpQoMa0ves,175
 pypilecore/api.py,sha256=EWJZuQn6ptJN4i-_GgVVoIF-3XI-lIfk0dJXsMXuFYQ,5109
 pypilecore/exceptions.py,sha256=-MZOfsxyHLCI0k1-wZFfVsMxc1lya5buuhLks5rxlCo,89
 pypilecore/plot_utils.py,sha256=rK5_067-4-x7LzZgt_t6ahcGrZInxNrqHqsy0RzCnq8,954
 pypilecore/utils.py,sha256=ib9LgJBIgWukL7zd_Zk1LP27UTMIZTRJ4RBB6ubn97o,1186
-pypilecore/input/__init__.py,sha256=os86dERd440xXlWDI1B_WXG8VnhStcodXMiJRePUHno,516
-pypilecore/input/grouper_properties.py,sha256=m95tJkJWHk9-quYbHimax7UrPtIkm99BR9DxQ0SvcS8,10872
-pypilecore/input/multi_cpt.py,sha256=0gBhSACNAOFjCoM6GAEBeoQszan5lGDS35cBQMarJCI,18589
+pypilecore/input/__init__.py,sha256=tlmThdPtO8e6L6pqxuRQ7EOHRxYwuIcaNNGlZyAnzig,606
+pypilecore/input/grouper_properties.py,sha256=Dw17aQUyEflPOz3QEOZLx_3A4L0ctmaMtKJgBMWY14Q,10881
+pypilecore/input/multi_cpt.py,sha256=ODrFHakObVBF0nx3-YaY7ZeQwM1wcydvJBjQxjyH7No,19036
 pypilecore/input/pile_properties.py,sha256=mK8_VRy-tHZCKFHcv8ftMlCEs8KEsZpG9eGLq13hYPA,8400
 pypilecore/input/soil_properties.py,sha256=ydYW9p3SWurOR-SndocPoyCCb6yWIN9aRjf5ZdpXU0c,6927
-pypilecore/results/__init__.py,sha256=4dhcm34Ui55jyn9QhA-R0KZWuFQpbrfWkHx184g-MUE,317
-pypilecore/results/grouper_result.py,sha256=qWaUh28QfWy9wG47mckfvB0MXxIW6fu3UJRz6i1qW4k,18881
+pypilecore/results/__init__.py,sha256=ggTI2QzILhX_oNx1YMOih6IVCkBFg8I5-Jyn9Sw3_h0,389
+pypilecore/results/grouper_result.py,sha256=C_6zOeuxhhemzssvQZ-JO3ZNzR0A9BTPduzYVUqkYY8,19596
 pypilecore/results/load_settlement.py,sha256=EbfTrSvH_g96KE-x8ZjmO8D0mt5KFaQ_-AR8u4blLsU,9752
-pypilecore/results/multi_cpt_results.py,sha256=1SlPQYIv7KFpKloZn9Q1cPUMnXbK7dVpkGlPm_WxHkQ,22390
+pypilecore/results/multi_cpt_results.py,sha256=vZLy7CRUHnShVzuiixfzGWZEdxeMMLWv57Xm_x8rDu4,22466
 pypilecore/results/pile_properties.py,sha256=z1R5UNoYjBem2rS8LMJ_ye2J5ejDoSilU5fCjUrNdUg,28592
 pypilecore/results/single_cpt_results.py,sha256=-fmlgBPyCSyID7d-u-pPUdu5PLExtyKQc2kXQFNhQvs,17564
 pypilecore/results/soil_properties.py,sha256=oZYTKSXP5UgxY2vwX-bu_X447KLptuYPpsgFi_E00IQ,20704
-py_pilecore-0.2.0.dist-info/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
-py_pilecore-0.2.0.dist-info/METADATA,sha256=CTyXpsGhjw42a9REa0aHw6euEocsQ04_fEgkjQxxB24,5637
-py_pilecore-0.2.0.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
-py_pilecore-0.2.0.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
-py_pilecore-0.2.0.dist-info/RECORD,,
+py_pilecore-0.2.2.dist-info/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
+py_pilecore-0.2.2.dist-info/METADATA,sha256=24wOC2CAWO8KCvh3krv4zYWQBy7uVcjRf_6CX49NtBA,5775
+py_pilecore-0.2.2.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
+py_pilecore-0.2.2.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
+py_pilecore-0.2.2.dist-info/RECORD,,

pypilecore/_version.py

@@ -4,4 +4,4 @@ try:
     __version__ = version("py-pilecore")
 # during CI
 except PackageNotFoundError:
-    __version__ = "0.2.0"
+    __version__ = "0.2.2"

pypilecore/input/__init__.py

@@ -1,7 +1,13 @@
-from .grouper_properties import create_grouper_payload, create_grouper_report_payload
-from .multi_cpt import create_multi_cpt_payload, create_multi_cpt_report_payload
-from .pile_properties import create_pile_properties_payload
-from .soil_properties import create_soil_properties_payload
+from pypilecore.input.grouper_properties import (
+    create_grouper_payload,
+    create_grouper_report_payload,
+)
+from pypilecore.input.multi_cpt import (
+    create_multi_cpt_payload,
+    create_multi_cpt_report_payload,
+)
+from pypilecore.input.pile_properties import create_pile_properties_payload
+from pypilecore.input.soil_properties import create_soil_properties_payload
 
 __all__ = [
     "create_pile_properties_payload",

pypilecore/input/grouper_properties.py

@@ -7,7 +7,7 @@ from typing import Any, Dict, List, Literal
 import numpy as np
 from shapely.geometry import Polygon, mapping
 
-from ..results import SingleCPTBearingResults
+from pypilecore.results import SingleCPTBearingResults
 
 _dft_optimize_result_by = [
     "minimum_pile_level",

pypilecore/input/multi_cpt.py

@@ -6,8 +6,8 @@ from typing import Dict, List, Literal, Mapping, Sequence, Tuple
 
 from pygef.cpt import CPTData
 
-from .pile_properties import create_pile_properties_payload
-from .soil_properties import create_soil_properties_payload
+from pypilecore.input.pile_properties import create_pile_properties_payload
+from pypilecore.input.soil_properties import create_soil_properties_payload
 
 
 def create_multi_cpt_payload(
@@ -28,7 +28,7 @@ def create_multi_cpt_payload(
     fixed_positive_friction_range_nap: Tuple[float, str | float] | None = None,
     negative_shaft_friction: float | None = None,
     apply_qc3_reduction: bool | None = None,
-    relative_pile_load: float = 0.7,
+    relative_pile_load: float | None = 0.7,
     pile_load_sls: float | None = None,
     soil_load_sls: float = 0.0,
     pile_head_level_nap: float | Literal["surface"] = "surface",
@@ -280,6 +280,16 @@ def create_multi_cpt_payload(
         - if `pile_shape`=="rect" & `width_base_large` is None
         - if `pile_shape` not in ["rect", "round"]
     """
+    # Input validation
+    if excavation_depth_nap is not None and excavation_param_t is None:
+        raise ValueError(
+            "`excavation_param_t` cannot be None when `excavation_depth_nap` is not None."
+        )
+    if relative_pile_load is None and pile_load_sls is None:
+        raise ValueError(
+            "Need at least a value for one of: [`relative_pile_load`, `pile_load_sls`]"
+        )
+
     soil_properties_list, results_kwargs = create_soil_properties_payload(
         cptdata_objects=cptdata_objects,
         classify_tables=classify_tables,

pypilecore/results/__init__.py

@@ -1,7 +1,7 @@
-from .grouper_result import GrouperResults
-from .multi_cpt_results import MultiCPTBearingResults
-from .single_cpt_results import SingleCPTBearingResults
-from .soil_properties import SoilProperties
+from pypilecore.results.grouper_result import GrouperResults
+from pypilecore.results.multi_cpt_results import MultiCPTBearingResults
+from pypilecore.results.single_cpt_results import SingleCPTBearingResults
+from pypilecore.results.soil_properties import SoilProperties
 
 __all__ = [
     "MultiCPTBearingResults",

pypilecore/results/grouper_result.py

@@ -527,6 +527,15 @@ class GrouperResults:
         Plot contains the:
 
             - cpts within a subgroup
+                - green:
+                    Subgroups is spatially coherent, which means there are no other CPTs in between the members
+                    of the subgroup and follows the NEN9997-1 3.2.3 centre to centre validation
+                - orange:
+                    Subgroups is spatially coherent, which means there are no other CPTs in between the members
+                    of the subgroup and does not follow the NEN9997-1 3.2.3 centre to centre validation
+                - red:
+                    Subgroups is not spatially coherent, which means there are other CPTs in between the
+                    members of the subgroup and does not follow the NEN9997-1 3.2.3 centre to centre validation
             - valid depth of the subgroup
 
         Parameters

pypilecore/results/multi_cpt_results.py

@@ -8,10 +8,13 @@ import numpy as np
 import pandas as pd
 from matplotlib.axes import Axes
 
-from ..exceptions import UserError
-from .load_settlement import get_load_settlement_plot
-from .pile_properties import PileProperties, create_pile_properties_from_api_response
-from .single_cpt_results import SingleCPTBearingResults
+from pypilecore.exceptions import UserError
+from pypilecore.results.load_settlement import get_load_settlement_plot
+from pypilecore.results.pile_properties import (
+    PileProperties,
+    create_pile_properties_from_api_response,
+)
+from pypilecore.results.single_cpt_results import SingleCPTBearingResults
 
 Number = Union[float, int]