py-pilecore 0.7.1__tar.gz → 0.8.0__tar.gz

{py_pilecore-0.7.1/src/py_pilecore.egg-info → py_pilecore-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-pilecore
-Version: 0.7.1
+Version: 0.8.0
 Summary: Public python SDK for the CEMS PileCore web-API.
 License: MIT License
         

{py_pilecore-0.7.1 → py_pilecore-0.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "py-pilecore"
-version = "0.7.1"
+version = "0.8.0"
 description = "Public python SDK for the CEMS PileCore web-API."
 requires-python = ">=3.9"
 dependencies = [

{py_pilecore-0.7.1 → py_pilecore-0.8.0/src/py_pilecore.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-pilecore
-Version: 0.7.1
+Version: 0.8.0
 Summary: Public python SDK for the CEMS PileCore web-API.
 License: MIT License
         

{py_pilecore-0.7.1 → py_pilecore-0.8.0}/src/pypilecore/_version.py

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

{py_pilecore-0.7.1 → py_pilecore-0.8.0}/src/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: