py-pilecore 0.2.5__tar.gz → 0.3.1__tar.gz

{py-pilecore-0.2.5/src/py_pilecore.egg-info → py-pilecore-0.3.1}/PKG-INFO

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

{py-pilecore-0.2.5 → py-pilecore-0.3.1}/pyproject.toml

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

{py-pilecore-0.2.5 → py-pilecore-0.3.1/src/py_pilecore.egg-info}/PKG-INFO

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

{py-pilecore-0.2.5 → py-pilecore-0.3.1}/src/pypilecore/_version.py

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

{py-pilecore-0.2.5 → py-pilecore-0.3.1}/src/pypilecore/input/multi_cpt.py

@@ -24,6 +24,7 @@ def create_multi_cpt_payload(
     ] = "lower_bound",
     stiff_construction: bool = False,
     cpts_group: List[str] | None = None,
+    ocr: float | None = None,
     fixed_negative_friction_range_nap: Tuple[float, float] | None = None,
     fixed_positive_friction_range_nap: Tuple[float, Literal["ptl"] | float]
     | None = None,
@@ -41,6 +42,7 @@ def create_multi_cpt_payload(
         str, Tuple[float, Literal["ptl"] | float]
     ]
     | None = None,
+    individual_ocr: Mapping[str, float] | None = None,
     diameter_base: float | None = None,
     diameter_shaft: float | None = None,
     width_base_large: float | None = None,
@@ -129,6 +131,8 @@ def create_multi_cpt_payload(
     cpts_group:
         CPTs that are considered one group. Items must relate to the alias of the CPTData
         objects in `cptdata_objects`.
+    ocr:
+        The Over-Consolidation-Ratio [-] of the foundation layer.
     fixed_negative_friction_range_nap:
         Optionally sets the fixed depth range between which the negative sleeve friction
         is calculated. If an array of format [top, bottom], the range is set between top
@@ -189,6 +193,10 @@ def create_multi_cpt_payload(
     individual_positive_friction_range_nap:
         A dictionary, mapping ``CPTData.alias`` values to fixed positive-friction ranges.
         For a specification of the values, see ``fixed_positive_friction_range_nap``
+    individual_ocr:
+        A dictionary, mapping ``CPTData.alias`` values to Over-Consolidation-Ratio [-]
+        values of the foundation layer. This will overrule the general `ocr` setting for
+        these specific CPTs only.
     diameter_base:
         Pile base diameter [m].
         Only relevant if ``pile_shape`` = "round".
@@ -299,8 +307,10 @@ def create_multi_cpt_payload(
         groundwater_level_nap=groundwater_level_nap,
         friction_range_strategy=friction_range_strategy,
         excavation_depth_nap=excavation_depth_nap,
+        master_ocr=ocr,
         individual_negative_friction_range_nap=individual_negative_friction_range_nap,
         individual_positive_friction_range_nap=individual_positive_friction_range_nap,
+        individual_ocr=individual_ocr,
     )
     pile_properties = create_pile_properties_payload(
         pile_type=pile_type,

{py-pilecore-0.2.5 → py-pilecore-0.3.1}/src/pypilecore/input/soil_properties.py

@@ -15,10 +15,6 @@ transform = {
     "peat": "V",
 }
 
-# Create input_table
-results_passover = {}
-soil_properties_list = []
-
 
 def create_soil_properties_payload(
     cptdata_objects: List[CPTData],
@@ -26,12 +22,14 @@ def create_soil_properties_payload(
     groundwater_level_nap: float,
     friction_range_strategy: Literal["manual", "lower_bound", "settlement_driven"],
     excavation_depth_nap: float | None = None,
+    master_ocr: float | None = None,
     individual_negative_friction_range_nap: Mapping[Any, Tuple[float, float]]
     | None = None,
     individual_positive_friction_range_nap: Mapping[
         Any, Tuple[float, Literal["ptl"] | float]
     ]
     | None = None,
+    individual_ocr: Mapping[Any, float] | None = None,
 ) -> Tuple[List[dict], Dict[str, dict]]:
     """
     Creates a dictionary with the `soil_properties` payload content for the PileCore
@@ -79,12 +77,18 @@ def create_soil_properties_payload(
         "lower_bound" or "settlement_driven".
     excavation_depth_nap:
         Soil excavation depth after the CPT was taken. Unit: [m] w.r.t. NAP.
+    ocr:
+        The Over-Consolidation-Ratio [-] of the foundation layer.
     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`
     individual_positive_friction_range_nap:
         A dictionary, mapping `CPTData.alias` values to fixed positive-friction ranges.
         For a specification of the values, see `fixed_positive_friction_range_nap`
+    individual_ocr:
+        A dictionary, mapping ``CPTData.alias`` values to Over-Consolidation-Ratio [-]
+        values of the foundation layer. This will overrule the general `ocr` setting for
+        these specific CPTs only.
 
     Returns
     -------
@@ -95,6 +99,10 @@ def create_soil_properties_payload(
         Dictionary with keyword arguments for the `pilecore.MultiCPTBearingResults`
         object.
     """
+    # Initialize outputs
+    results_passover = {}
+    soil_properties_list = []
+
     for cpt in tqdm(cptdata_objects, desc="Create soil properties payload"):
         # Construct the cpt_data payload
         cpt_data = dict(
@@ -158,6 +166,14 @@ def create_soil_properties_payload(
                     "fixed_positive_friction_range_nap"
                 ] = individual_positive_friction_range_nap[cpt.alias]
 
+        # Optionally add OCR parameter
+        if individual_ocr is not None and cpt.alias in individual_ocr.keys():
+            ocr: float | None = individual_ocr[cpt.alias]
+        else:
+            ocr = master_ocr
+        if ocr is not None:
+            soil_properties["ocr"] = ocr
+
         soil_properties_list.append(soil_properties)
         results_passover[cpt.alias] = {
             "ref_height": cpt.delivered_vertical_position_offset,

{py-pilecore-0.2.5 → py-pilecore-0.3.1}/src/pypilecore/results/grouper_result.py

@@ -279,6 +279,7 @@ class SingleClusterResult:
         cls, response_dict: dict, pile_load_uls: float
     ) -> "SingleClusterResult":
         try:
+            table = response_dict["table"]
             return cls(
                 cpt_names=response_dict["names"],
                 coordinates=response_dict["coordinates"],
@@ -292,7 +293,37 @@ class SingleClusterResult:
                 spatial_check=response_dict["spatial_check"],
                 variation_check=response_dict["variation_check"],
                 centre_to_centre_check=response_dict["centre_to_centre_check"],
-                data=SingleClusterData(**response_dict["table"]),
+                data=SingleClusterData(
+                    characteristic_bearing_capacity=table[
+                        "characteristic_bearing_capacity"
+                    ],
+                    design_bearing_capacity=table["design_bearing_capacity"],
+                    design_negative_friction=table["design_negative_friction"],
+                    group_centre_to_centre_validation=table[
+                        "group_centre_to_centre_validation"
+                    ],
+                    group_centre_to_centre_validation_15=table[
+                        "group_centre_to_centre_validation_15"
+                    ],
+                    group_centre_to_centre_validation_20=table[
+                        "group_centre_to_centre_validation_20"
+                    ],
+                    group_centre_to_centre_validation_25=table[
+                        "group_centre_to_centre_validation_25"
+                    ],
+                    mean_calculated_bearing_capacity=table[
+                        "mean_calculated_bearing_capacity"
+                    ],
+                    min_calculated_bearing_capacity=table[
+                        "min_calculated_bearing_capacity"
+                    ],
+                    net_design_bearing_capacity=table["net_design_bearing_capacity"],
+                    nominal_cpt=table["nominal_cpt"],
+                    pile_tip_level=table["pile_tip_level"],
+                    variation_coefficient=table["variation_coefficient"],
+                    xi_factor=table["xi_factor"],
+                    xi_values=table["xi_values"],
+                ),
             )
         except KeyError as e:
             raise KeyError(

{py-pilecore-0.2.5 → py-pilecore-0.3.1}/src/pypilecore/results/multi_cpt_results.py

@@ -30,6 +30,8 @@ class CPTGroupResultsTable:
         R_s_k: Sequence[float],
         R_b_k: Sequence[float],
         R_c_k: Sequence[float],
+        R_s_d: Sequence[float],
+        R_b_d: Sequence[float],
         R_c_d: Sequence[float],
         F_nk_cal_mean: Sequence[float],
         F_nk_k: Sequence[float],
@@ -70,6 +72,10 @@ class CPTGroupResultsTable:
             The characteristic value of the bottom bearingcapacity [kN].
         R_c_k:
             The characteristic value of the total compressive bearingcapacity [kN].
+        R_s_d:
+            The design value of the shaft bearingcapacity  [kN].
+        R_b_d:
+            The design value of the bottom bearingcapacity [kN].
         R_c_d:
             The design value of the total bearingcapacity [kN].
         F_nk_cal_mean:
@@ -137,6 +143,10 @@ class CPTGroupResultsTable:
         """The characteristic value of the bottom bearingcapacity [kN]."""
         self.R_c_k = np.array(R_c_k).astype(np.float64)
         """The characteristic value of the total compressive bearingcapacity [kN]."""
+        self.R_s_d = np.array(R_s_d).astype(np.float64)
+        """The design value of the shaft bearingcapacity  [kN]."""
+        self.R_b_d = np.array(R_b_d).astype(np.float64)
+        """The design value of the bottom bearingcapacity [kN]."""
         self.R_c_d = np.array(R_c_d).astype(np.float64)
         """The design value of the total bearingcapacity [kN]."""
         self.F_nk_cal_mean = np.array(F_nk_cal_mean).astype(np.float64)
@@ -453,13 +463,56 @@ class MultiCPTBearingResults:
         cpt_results_dict = SingleCPTBearingResultsContainer.from_api_response(
             cpt_results_list=response_dict["cpts"], cpt_input=cpt_input
         )
-
+        group_results = response_dict["group_results"]
         return cls(
             cpt_results=cpt_results_dict,
             pile_properties=create_pile_properties_from_api_response(
                 response_dict["pile_properties"]
             ),
-            group_results_table=CPTGroupResultsTable(**response_dict["group_results"]),
+            group_results_table=CPTGroupResultsTable(
+                pile_tip_level_nap=group_results["pile_tip_level_nap"],
+                R_s_k=group_results["R_s_k"],
+                R_b_k=group_results["R_b_k"],
+                R_c_k=group_results["R_c_k"],
+                R_s_d=group_results["R_s_d"]
+                if "R_s_d" in group_results
+                else np.full_like(
+                    group_results["pile_tip_level_nap"], fill_value=np.nan
+                ),  # For backwards compatibility with PileCore-API < 2.9.0
+                R_b_d=group_results["R_b_d"]
+                if "R_b_d" in group_results
+                else np.full_like(
+                    group_results["pile_tip_level_nap"], fill_value=np.nan
+                ),  # For backwards compatibility with PileCore-API < 2.9.0,
+                R_c_d=group_results["R_c_d"],
+                F_nk_cal_mean=group_results["F_nk_cal_mean"],
+                F_nk_k=group_results["F_nk_k"],
+                F_nk_d=group_results["F_nk_d"],
+                R_c_d_net=group_results["R_c_d_net"],
+                F_c_k=group_results["F_c_k"],
+                F_c_k_tot=group_results["F_c_k_tot"],
+                s_b=group_results["s_b"],
+                s_e=group_results["s_e"],
+                s_e_mean=group_results["s_e_mean"],
+                R_b_mob_ratio=group_results["R_b_mob_ratio"],
+                R_s_mob_ratio=group_results["R_s_mob_ratio"],
+                k_v_b=group_results["k_v_b"],
+                k_v_1=group_results["k_v_1"],
+                R_c_min=group_results["R_c_min"],
+                R_c_max=group_results["R_c_max"],
+                R_c_mean=group_results["R_c_mean"],
+                R_c_std=group_results["R_c_std"],
+                R_s_mean=group_results["R_s_mean"],
+                R_b_mean=group_results["R_b_mean"],
+                var_coef=group_results["var_coef"],
+                n_cpts=group_results["n_cpts"],
+                use_group_average=group_results["use_group_average"],
+                xi_normative=group_results["xi_normative"],
+                xi_value=group_results["xi_value"],
+                cpt_Rc_min=group_results["cpt_Rc_min"],
+                cpt_Rc_max=group_results["cpt_Rc_max"],
+                cpt_normative=group_results["cpt_normative"],
+            ),
             gamma_f_nk=response_dict["calculation_params"]["gamma_f_nk"],
             gamma_r_b=response_dict["calculation_params"]["gamma_r_b"],
             gamma_r_s=response_dict["calculation_params"]["gamma_r_s"],

{py-pilecore-0.2.5 → py-pilecore-0.3.1}/src/pypilecore/results/single_cpt_results.py

@@ -241,6 +241,7 @@ class SingleCPTBearingResults:
         x: float | None = None,
         y: float | None = None,
     ) -> "SingleCPTBearingResults":
+        results_table = cpt_results_dict["results_table"]
         return cls(
             soil_properties=SoilProperties(
                 cpt_table=CPTTable.from_api_response(
@@ -256,7 +257,45 @@ class SingleCPTBearingResults:
                 y=y,
             ),
             pile_head_level_nap=cpt_results_dict["annotations"]["pile_head_level_nap"],
-            results_table=CPTResultsTable(**cpt_results_dict["results_table"]),
+            results_table=CPTResultsTable(
+                pile_tip_level_nap=results_table["pile_tip_level_nap"],
+                F_nk_cal=results_table["F_nk_cal"],
+                F_nk_k=results_table["F_nk_k"],
+                F_nk_d=results_table["F_nk_d"],
+                R_b_cal=results_table["R_b_cal"],
+                R_b_k=results_table["R_b_k"],
+                R_b_d=results_table["R_b_d"],
+                R_s_cal=results_table["R_s_cal"],
+                R_s_k=results_table["R_s_k"],
+                R_s_d=results_table["R_s_d"],
+                R_c_cal=results_table["R_c_cal"],
+                R_c_k=results_table["R_c_k"],
+                R_c_d=results_table["R_c_d"],
+                R_c_d_net=results_table["R_c_d_net"],
+                F_c_k=results_table["F_c_k"],
+                F_c_k_tot=results_table["F_c_k_tot"],
+                negative_friction_range_nap_top=results_table[
+                    "negative_friction_range_nap_top"
+                ],
+                negative_friction_range_nap_btm=results_table[
+                    "negative_friction_range_nap_btm"
+                ],
+                positive_friction_range_nap_top=results_table[
+                    "positive_friction_range_nap_top"
+                ],
+                positive_friction_range_nap_btm=results_table[
+                    "positive_friction_range_nap_btm"
+                ],
+                q_b_max=results_table["q_b_max"],
+                q_s_max_mean=results_table["q_s_max_mean"],
+                qc1=results_table["qc1"],
+                qc2=results_table["qc2"],
+                qc3=results_table["qc3"],
+                s_b=results_table["s_b"],
+                s_el=results_table["s_el"],
+                k_v_b=results_table["k_v_b"],
+                k_v_1=results_table["k_v_1"],
+            ),
         )
 
     @property

{py-pilecore-0.2.5 → py-pilecore-0.3.1}/tests/test_input.py

@@ -369,7 +369,9 @@ def test_create_multi_cpt_payload_defaults(
     # Check the payload content
 
     # We don't completely check the soil_properties list here
-    assert isinstance(payload.pop("list_soil_properties"), list)
+    list_soil_properties = payload.pop("list_soil_properties")
+    assert isinstance(list_soil_properties, list)
+    assert len(list_soil_properties) == 1
 
     assert payload.pop("excavation_param_t") == 1.0
     assert payload.pop("pile_head_level_nap") == "surface"
@@ -513,6 +515,8 @@ def test_create_multi_cpt_payload_extended_rect_pile(
     function with extended arguments for a rect pile.
     """
 
+    assert isinstance(cpt.alias, str)
+
     payload, _ = create_multi_cpt_payload(
         pile_tip_levels_nap=[0, 1],
         cptdata_objects=[cpt],
@@ -561,7 +565,9 @@ def test_create_multi_cpt_payload_extended_rect_pile(
     # Check the payload content
 
     # We don't completely check the soil_properties list here
-    assert isinstance(payload.pop("list_soil_properties"), list)
+    list_soil_properties = payload.pop("list_soil_properties")
+    assert isinstance(list_soil_properties, list)
+    assert len(list_soil_properties) == 1
 
     assert payload.pop("excavation_param_t") == 0.5
     assert payload.pop("pile_head_level_nap") == 5.0
@@ -615,6 +621,59 @@ def test_create_multi_cpt_payload_extended_rect_pile(
     assert len(payload.keys()) == 0
 
 
+def test_create_multi_cpt_payload_extended_ocr(
+    cpt: CPTData, mock_classify_response: dict
+) -> None:
+    """
+    Test creating the multi_cpt_results payload with the `create_multi_cpt_payload`
+    function with extended OCR arguments.
+    """
+
+    payload, _ = create_multi_cpt_payload(
+        pile_tip_levels_nap=[0, 1],
+        cptdata_objects=[cpt],
+        classify_tables={cpt.alias: mock_classify_response},
+        groundwater_level_nap=-2.5,
+        pile_type="concrete",
+        specification="1",
+        installation="A",
+        pile_shape="round",
+        diameter_base=0.3,
+        ocr=2.5,
+    )
+
+    # Check the payload content
+
+    list_soil_properties = payload.get("list_soil_properties")
+    assert isinstance(list_soil_properties, list)
+    assert len(list_soil_properties) == 1
+    assert "ocr" in list_soil_properties[0].keys()
+    assert np.isclose(list_soil_properties[0]["ocr"], 2.5)
+
+    # Case 2: set OCR with individual_ocr parameter
+
+    payload, _ = create_multi_cpt_payload(
+        pile_tip_levels_nap=[0, 1],
+        cptdata_objects=[cpt],
+        classify_tables={cpt.alias: mock_classify_response},
+        groundwater_level_nap=-2.5,
+        pile_type="concrete",
+        specification="1",
+        installation="A",
+        pile_shape="round",
+        diameter_base=0.3,
+        ocr=1.0,
+        individual_ocr={cpt.alias: 2.0},
+    )
+
+    # Check the payload content
+
+    list_soil_properties = payload.pop("list_soil_properties")
+    assert isinstance(list_soil_properties, list)
+    assert "ocr" in list_soil_properties[0].keys()
+    assert np.isclose(list_soil_properties[0]["ocr"], 2.0)
+
+
 def test_create_multi_cpt_payload_errors(
     cpt: CPTData, mock_classify_response: dict
 ) -> None: