py-pilecore 0.7.1__py3-none-any.whl → 0.8.1__py3-none-any.whl

{py_pilecore-0.7.1.dist-info → py_pilecore-0.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-pilecore
-Version: 0.7.1
+Version: 0.8.1
 Summary: Public python SDK for the CEMS PileCore web-API.
 License: MIT License
         
@@ -168,3 +168,9 @@ Update the requirements within the defined ranges with:
 ```bash
 pip-compile --upgrade --extra=test --extra=lint --extra=docs --output-file=requirements.txt pyproject.toml
 ```
+
+Note that `pip-compile` might run from your global path. You can also invoke the compile
+command from the `piptools` module on a specific python installation (e.g. within a virtualenv):
+
+```bash
+python -m piptools compile

{py_pilecore-0.7.1.dist-info → py_pilecore-0.8.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 pypilecore/__init__.py,sha256=oJvwYShj_7FyNVlUgQda4tTdYyLIi5H1asdiS_uYt9M,162
-pypilecore/_version.py,sha256=lwhPyTTgYzs-cvOxSAquZ8lujNcRnmmZe1m2wWaWutg,175
+pypilecore/_version.py,sha256=hAEHEjBRfehOjTMw00czgS3SD_ZC3KWh5Zvf9h2LEW4,175
 pypilecore/api.py,sha256=QwwHXR6HYtrF-gCHQWLvMHZnTxf5fjTlWI2cGfYSkUc,7165
 pypilecore/exceptions.py,sha256=-MZOfsxyHLCI0k1-wZFfVsMxc1lya5buuhLks5rxlCo,89
 pypilecore/plot_utils.py,sha256=rK5_067-4-x7LzZgt_t6ahcGrZInxNrqHqsy0RzCnq8,954
@@ -17,8 +17,8 @@ pypilecore/common/piles/geometry/components/rectangle.py,sha256=591KyIejyjNAMnKg
 pypilecore/common/piles/geometry/components/round.py,sha256=MX2_qGmxr1dTtodblFfkNGkoDYqd6xgXHJ57xFuz_Z0,14735
 pypilecore/input/__init__.py,sha256=Gyqsp6zqc8AYnIp17SfqbBNjDaUkRgAam8x2r0XibwM,492
 pypilecore/input/grouper_properties.py,sha256=4Rhea8pnrbWqIIiplHdPS-EioDRurCcLe6thHkGkBEM,11146
-pypilecore/input/multi_cpt.py,sha256=V7A_MAYeJoMkGOQu1oFGJfJ3dkuBdhDSfeLvgiCLmqs,14196
-pypilecore/input/soil_properties.py,sha256=ms2zxRPK_0zJAgei4QTJhC71Y7ivUguqoRTDUzuqyl8,8277
+pypilecore/input/multi_cpt.py,sha256=b5poixEs5ex8WGcu3rJiFMdS5Q4DE807L6jmeqiFE64,17506
+pypilecore/input/soil_properties.py,sha256=fsgkdvLsNf7LqiQh-gIDS9XSZBO7BJJ_qp6bIs8TLz0,9061
 pypilecore/results/__init__.py,sha256=J6CHQ7BJRnUJxrKFe25br-BUCMrBATqmvRkjtaMkmkw,507
 pypilecore/results/cases_multi_cpt_results.py,sha256=Svy26fEMuSLPzD0hdq3-aQD-6TK0oyAERkVQZFPcXrE,9948
 pypilecore/results/grouper_result.py,sha256=HcjLbnD3wt28CtIACD1OSoyJRmfu5x8Qv2BdDMpvgyY,30952
@@ -37,8 +37,8 @@ pypilecore/viewers/interactive_figures/figure_cpt_group_results_versus_ptls.py,s
 pypilecore/viewers/interactive_figures/figure_cpt_results_plan_view.py,sha256=y1no2w0zN0yUpkNB_-WAFwQfa-IS70hJMhc-c0pOeMs,9268
 pypilecore/viewers/interactive_figures/figure_cpt_results_versus_ptls.py,sha256=6huCKcQ4bsBE-LNY-ZPa13IWuye0ENxPK4wT1dcCFRs,5964
 pypilecore/viewers/interactive_figures/utils.py,sha256=B2X8hbbmJqjm8E2VrS2EoX5F1yQ5qOQnQUG_vbsseT8,1692
-py_pilecore-0.7.1.dist-info/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
-py_pilecore-0.7.1.dist-info/METADATA,sha256=_EToNm1nMkzfEYcHpOMioBk8Uc5IGfPWE3UPOOxpNXw,5653
-py_pilecore-0.7.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-py_pilecore-0.7.1.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
-py_pilecore-0.7.1.dist-info/RECORD,,
+py_pilecore-0.8.1.dist-info/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
+py_pilecore-0.8.1.dist-info/METADATA,sha256=lqEfiUaVFto9lSj1I57R6eruvdG1hcBt7cV9WeNdWaY,5876
+py_pilecore-0.8.1.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+py_pilecore-0.8.1.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
+py_pilecore-0.8.1.dist-info/RECORD,,

{py_pilecore-0.7.1.dist-info → py_pilecore-0.8.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.5.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pypilecore/_version.py

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

pypilecore/input/multi_cpt.py

@@ -33,6 +33,9 @@ def create_multi_cpt_payload(
     pile_head_level_nap: float | Literal["surface"] = "surface",
     excavation_depth_nap: float | None = None,
     excavation_param_t: float = 1.0,
+    excavation_stress_reduction_method: Literal["constant", "begemann"] = "constant",
+    excavation_width: float | None = None,
+    excavation_edge_distance: float | None = None,
     individual_negative_friction_range_nap: Mapping[str, Tuple[float, float]]
     | None = None,
     individual_positive_friction_range_nap: Mapping[
@@ -160,6 +163,27 @@ def create_multi_cpt_payload(
               excavation method.
 
         See for more info NEN 9997-1+C2:2017 7.6.2.3.(10)(k)
+    excavation_stress_reduction_method:
+        Method used to calculate the stress reduction due to the excavation applied to the effective and total stresses.
+        Only used when `excavation_depth_nap` is different than `None`. It can be:
+            - "constant" (default): The stress reduction below the excavation is constant with depth. The stress reduction
+            is equal to the original effective stress (i.e. before the excavation) at the excavation depth.
+            - "begemann": The stress reduction below the excavation decreases with depth according to the Begemann method.
+            This method uses the elastic solution of a strip load acting on a semi-infinite homogeneous soil mass.
+            The load has a width equal to the excavation width and a magnitude equal to the original effective stress at
+            the excavation depth.
+        Regardless the method, the stress reduction applied above the excavation is equal to the original effective stress
+        at each corresponding depth.
+    excavation_width:
+        Width of the excavation [m]. Used to calculate the stress reduction due to the excavation if the Begemann method is selected.
+        In this case, it must be provided and it must be > 0.
+    excavation_edge_distance:
+        Distance from the pile centerline to the excavation edge [m]. Used to calculate the stress reduction due to the excavation if
+        the Begemann method is selected. In this case, it must be provided and it must be between 0.0 and 0.5 * excavation_width.
+
+        Note that:
+            - 0.0 means that the pile is located at the edge of the excavation.
+            - 0.5 * excavation_width means that the pile is at the center of the excavation.
     individual_negative_friction_range_nap:
         A dictionary, mapping ``CPTData.alias`` values to fixed negative-friction ranges.
         For a specification of the values, see ``fixed_negative_friction_range_nap``
@@ -201,6 +225,9 @@ def create_multi_cpt_payload(
     ------
     ValueError:
         - If `excavation_depth_nap` is not None and `excavation_param_t` is None.
+        - If `excavation_stress_reduction_method` is not either 'constant' or 'begemann'.
+        - If `excavation_stress_reduction_method` is 'begemann' and `excavation_width` is None.
+        - If `excavation_stress_reduction_method` is 'begemann' and `excavation_edge_distance` is None.
         - If both `relative_pile_load` and `pile_load_sls` are None.
     """
     # Input validation
@@ -208,6 +235,21 @@ def create_multi_cpt_payload(
         raise ValueError(
             "`excavation_param_t` cannot be None when `excavation_depth_nap` is not None."
         )
+    if excavation_stress_reduction_method not in ["constant", "begemann"]:
+        raise ValueError(
+            "`excavation_stress_reduction_method` must be either 'constant' or 'begemann'."
+        )
+    if excavation_stress_reduction_method == "begemann" and excavation_width is None:
+        raise ValueError(
+            "`excavation_width` must be provided when `excavation_stress_reduction_method` is 'begemann'."
+        )
+    if (
+        excavation_stress_reduction_method == "begemann"
+        and excavation_edge_distance is None
+    ):
+        raise ValueError(
+            "`excavation_edge_distance` must be provided when `excavation_stress_reduction_method` is 'begemann'"
+        )
     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`]"
@@ -243,6 +285,18 @@ def create_multi_cpt_payload(
     # Add optional properties
     if excavation_depth_nap is not None:
         multi_cpt_payload["excavation_depth_nap"] = excavation_depth_nap
+
+    if excavation_stress_reduction_method == "constant":
+        multi_cpt_payload["excavation_settings"] = dict(
+            stress_reduction_method="constant"
+        )
+    else:
+        multi_cpt_payload["excavation_settings"] = dict(
+            stress_reductin_method="begemann",
+            excavation_width=excavation_width,
+            excavation_edge_distance=excavation_edge_distance,
+        )
+
     if pile_load_sls is not None:
         multi_cpt_payload["pile_load"] = pile_load_sls
     if apply_qc3_reduction is not None:

pypilecore/input/soil_properties.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
 
+import warnings
 from typing import Any, Dict, List, Literal, Mapping, Tuple
 
 import numpy as np
+from numpy.typing import NDArray
 from pygef.cpt import CPTData
 from tqdm import tqdm
 
@@ -16,6 +18,26 @@ transform = {
 }
 
 
+def get_cpt_depth(cpt: CPTData) -> NDArray:
+    """
+    Returns the array of depth data from the CPT. Uses the (corrected) depth data if
+    present, otherwise the `penetrationLength` data along with a warning.
+    """
+    if "depth" in cpt.data.columns:
+        depth = cpt.data["depth"]
+    elif "penetrationLength" in cpt.data.columns:
+        warnings.warn(
+            f"CPT {cpt.alias} has no Corrected Depth trace. py-pilecore uses the Penetration Length instead, which might not be accurate."
+        )
+        depth = cpt.data["penetrationLength"]
+    else:
+        raise ValueError(
+            f"Cannot process CPT {cpt.alias}: required Corrected Depth or Penetration Length data is missing."
+        )
+
+    return np.array(depth, dtype=float)
+
+
 def create_soil_properties_payload(
     cptdata_objects: List[CPTData],
     classify_tables: Dict[str, dict],
@@ -117,7 +139,7 @@ def create_soil_properties_payload(
 
         # Construct the cpt_data payload
         cpt_data = dict(
-            depth=np.array(cpt.data["depth"], dtype=float),
+            depth=get_cpt_depth(cpt),
             qc=np.array(cpt.data["coneResistance"], dtype=float).clip(0),
         )