py-pilecore 0.4.1__py3-none-any.whl → 0.5.0__py3-none-any.whl

pypilecore/input/soil_properties.py

@@ -30,6 +30,7 @@ def create_soil_properties_payload(
     ]
     | None = None,
     individual_ocr: Mapping[Any, float] | None = None,
+    verbose: bool = False,
 ) -> Tuple[List[dict], Dict[str, dict]]:
     """
     Creates a dictionary with the `soil_properties` payload content for the PileCore
@@ -89,6 +90,8 @@ def create_soil_properties_payload(
         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.
+    verbose:
+        If True, show progress bars and status messages in stdout.
 
     Returns
     -------
@@ -103,7 +106,15 @@ def create_soil_properties_payload(
     results_passover = {}
     soil_properties_list = []
 
-    for cpt in tqdm(cptdata_objects, desc="Create soil properties payload"):
+    pbar = None
+    if verbose:
+        pbar = tqdm(total=len(cptdata_objects))
+    for cpt in cptdata_objects:
+        # Push verbose message
+        if pbar:
+            pbar.update()
+            pbar.set_description(f"Create soil properties payload for CPT: {cpt.alias}")
+
         # Construct the cpt_data payload
         cpt_data = dict(
             depth=np.array(cpt.data["depth"], dtype=float),

pypilecore/results/grouper_result.py

@@ -9,6 +9,7 @@ import natsort
 import numpy as np
 import pandas as pd
 from matplotlib import pyplot as plt
+from matplotlib.axes import Axes
 from numpy.typing import NDArray
 from shapely import MultiPoint
 
@@ -184,7 +185,7 @@ class SingleClusterData:
         return pd.DataFrame(self.__dict__)
 
     def plot_variation_coefficient(
-        self, axes: plt.Axes | None = None, **kwargs: Any
+        self, axes: Axes | None = None, **kwargs: Any
     ) -> None:
         """
         Plot the bearing capacity and variation coefficient in a subplot
@@ -206,7 +207,7 @@ class SingleClusterData:
         axes.set_xlabel("Variation coefficient [-]")
 
     def plot_bearing_capacity(
-        self, axes: plt.Axes | None = None, pile_load_uls: float = 0.0, **kwargs: Any
+        self, axes: Axes | None = None, pile_load_uls: float = 0.0, **kwargs: Any
     ) -> None:
         """
         Plot the bearing capacity and variation coefficient in a subplot

pypilecore/results/multi_cpt_results.py

@@ -7,13 +7,11 @@ import matplotlib.pyplot as plt
 import numpy as np
 import pandas as pd
 from matplotlib.axes import Axes
+from matplotlib.patches import Patch
 
+from pypilecore.common.piles import PileProperties
 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]
@@ -473,7 +471,7 @@ class MultiCPTBearingResults:
         group_results = response_dict["group_results"]
         return cls(
             cpt_results=cpt_results_dict,
-            pile_properties=create_pile_properties_from_api_response(
+            pile_properties=PileProperties.from_api_response(
                 response_dict["pile_properties"]
             ),
             group_results_table=CPTGroupResultsTable(
@@ -548,6 +546,166 @@ class MultiCPTBearingResults:
         """The CPTGroupResultsTable dataclass, containing the group results."""
         return self._group_results_table
 
+    def boxplot(
+        self,
+        attribute: str,
+        axes: Axes | None = None,
+        figsize: Tuple[float, float] = (6.0, 6.0),
+        show_sqrt: bool = False,
+        **kwargs: Any,
+    ) -> Axes:
+        """
+        Plot a box and whisker plot for a given attribute.
+
+
+        .. code-block:: none
+
+                     MIN      Q1   median  Q3       MAX
+                               |-----:-----|
+                      |--------|     :     |--------|
+                               |-----:-----|
+
+        Parameters
+        ----------
+        attribute:
+            result attribute to create boxplot. Please note that the attribute name must be present in
+            the `CPTResultsTable` and `CPTGroupResultsTable` class.
+        axes:
+            Optional `Axes` object where the boxplot data can be plotted on.
+            If not provided, a new `plt.Figure` will be activated and the `Axes`
+            object will be created and returned.
+        figsize:
+            Size of the activate figure, as the `plt.figure()` argument.
+        show_sqrt:
+            Add sqrt(2) bandwidth to figure
+        **kwargs:
+            All additional keyword arguments are passed to the `pyplot.subplots()` call.
+
+        Returns
+        -------
+        axes:
+            The `Axes` object where the settlement curves were plotted on
+        """
+
+        # validate attribute
+        if (
+            attribute not in self.cpt_results.results[0].table.__dict__.keys()
+            or attribute not in self.group_results_table.__dict__.keys()
+        ):
+            raise ValueError(
+                f"""
+                {attribute} is not present in CPTResultsTable or CPTGroupResultsTable class.
+                Please select on of the following attributes:
+                {
+                    set(self.cpt_results.results[0].table.__dict__.keys())
+                     & set(self.group_results_table.__dict__.keys())
+                }
+                """
+            )
+
+        # Create axes objects if not provided
+        if axes is not None:
+            if not isinstance(axes, Axes):
+                raise ValueError(
+                    "'axes' argument to boxplot() must be a `pyplot.axes.Axes` object or None."
+                )
+        else:
+            kwargs_subplot = {
+                "figsize": figsize,
+                "tight_layout": True,
+            }
+
+            kwargs_subplot.update(kwargs)
+
+            _, axes = plt.subplots(
+                1,
+                1,
+                **kwargs_subplot,
+            )
+
+            if not isinstance(axes, Axes):
+                raise ValueError(
+                    "Could not create Axes objects. This is probably due to invalid matplotlib keyword arguments. "
+                )
+
+        # Collect data from single calculation
+        data = np.array(
+            [
+                item.table.__getattribute__(attribute)
+                for item in self.cpt_results.results
+            ]
+        )
+
+        # Draw a box and whisker plot
+        axes.boxplot(
+            np.flip(data, axis=0),
+            tick_labels=np.flip(self.group_results_table.pile_tip_level_nap),
+            whis=(0, 100),
+            autorange=True,
+            vert=False,
+            patch_artist=True,
+            showmeans=True,
+            zorder=0,
+        )
+
+        # ad additional bandwidth of sqrt(2) of the mean value
+        if show_sqrt:
+            axes.scatter(
+                np.flip(data.mean(axis=0)) * np.sqrt(2),
+                np.flip(
+                    np.arange(len(self.group_results_table.pile_tip_level_nap)) + 1
+                ),
+                marker="^",
+                color="tab:purple",
+                zorder=1,
+            )
+            axes.scatter(
+                np.flip(data.mean(axis=0)) / np.sqrt(2),
+                np.flip(
+                    np.arange(len(self.group_results_table.pile_tip_level_nap)) + 1
+                ),
+                marker="^",
+                color="tab:purple",
+                zorder=1,
+            )
+
+        # Draw group result over single result
+        axes.scatter(
+            np.flip(self.group_results_table.__getattribute__(attribute)),
+            np.flip(np.arange(len(self.group_results_table.pile_tip_level_nap)) + 1),
+            marker="o",
+            color="tab:red",
+            zorder=1,
+        )
+
+        # Draw group result over single result
+        for i, x in enumerate(data.mean(axis=0)):
+            axes.annotate(f"{x.round(2)}", xy=(x, i + 1))
+
+        # add legend to figure
+        axes.legend(
+            handles=[
+                Patch(color=clr, label=key)
+                for (key, clr) in {
+                    "Single;min:max": "black",
+                    "Single;Q25:Q75": "tab:blue",
+                    "Single;Q50": "tab:orange",
+                    "Single;mean": "tab:green",
+                    "Single;mean;sqrt": "tab:purple",
+                    "Group;normative": "tab:red",
+                }.items()
+            ],
+            loc="upper left",
+            bbox_to_anchor=(1, 1),
+            title=f"Bandwidth {attribute}",
+        )
+
+        # set label
+        axes.set_ylabel("Depth [m NAP]")
+        axes.set_xlabel(f"{attribute}")
+
+        return axes
+
     def plot_load_settlement(
         self,
         pile_tip_level_nap: float,
@@ -581,6 +739,12 @@ class MultiCPTBearingResults:
         axes:
             The `Axes` object where the settlement curves were plotted on
         """
+        # Validate required properties are present
+        if self._pp.pile_type.settlement_curve is None:
+            raise ValueError(
+                "No settlement curve is defined for the pile-type. "
+                "Please define a settlement curve in the pile-type properties."
+            )
 
         # Validate axes
         if (axes is not None) and (not isinstance(axes, Axes)):
@@ -608,8 +772,8 @@ class MultiCPTBearingResults:
             )
 
         return get_load_settlement_plot(
-            settlement_curve=self._pp.settlement_curve,
-            d_eq=self._pp.equiv_base_diameter,
+            settlement_curve=self._pp.pile_type.settlement_curve,
+            d_eq=self._pp.geometry.equiv_diameter_pile_tip,
             s_b=self.group_results_table.s_b[idx],
             f_c_k=self.group_results_table.F_c_k[idx],
             f_nk_k=self.group_results_table.F_nk_k[idx],

py_pilecore-0.4.1.dist-info/RECORD

@@ -1,24 +0,0 @@
-pypilecore/__init__.py,sha256=T2Uuao6fboVhrzKI_Sa7jXbcNAUl_PKk9BFdsozOG98,78
-pypilecore/_version.py,sha256=0_HYvCjqXJ8bLPFLe6E2tkYlW15w7EOTtTD9FQ5jQGM,175
-pypilecore/api.py,sha256=dXgjfttEUcQHUCMkTX9eYip0dd3bf_ppE6cdx87ouHY,6822
-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=tlmThdPtO8e6L6pqxuRQ7EOHRxYwuIcaNNGlZyAnzig,606
-pypilecore/input/grouper_properties.py,sha256=qOc-SNYSPdOcZZ9DsRE-sBNVOKHbUD044EWRsWDu_kc,10893
-pypilecore/input/multi_cpt.py,sha256=Ua5IN9-m1jgCwa5xFNAYrMcxkVe2L1LIW907CWLJBW0,19577
-pypilecore/input/pile_properties.py,sha256=6O7iH-f7_G9PZbBsbzSWT_zUF2RtwYLfF5GRtUFvhHk,8404
-pypilecore/input/soil_properties.py,sha256=oqZWeSvhGyIKl4j0ZlGr923qyxkBjYxbVKBckG2rLAw,7687
-pypilecore/results/__init__.py,sha256=ggTI2QzILhX_oNx1YMOih6IVCkBFg8I5-Jyn9Sw3_h0,389
-pypilecore/results/grouper_result.py,sha256=wQxWSJRrgh7aO5pglrCNTPvCNdERBMDXAlm6YZE3v-s,30927
-pypilecore/results/load_settlement.py,sha256=EbfTrSvH_g96KE-x8ZjmO8D0mt5KFaQ_-AR8u4blLsU,9752
-pypilecore/results/multi_cpt_results.py,sha256=dzNpP3hu0Sl00gNPHT37DcQqLbfp8IYci46QLSycyqA,25398
-pypilecore/results/pile_properties.py,sha256=z1R5UNoYjBem2rS8LMJ_ye2J5ejDoSilU5fCjUrNdUg,28592
-pypilecore/results/post_processing.py,sha256=UWXcdff5dhPFDwzKbVIayEIp3HX6pxW8oQR3Z7AHPn0,22262
-pypilecore/results/single_cpt_results.py,sha256=irNqsL_cBKUh-QEmWC216KZjkv9MAZkaiLTvDDlEt20,17448
-pypilecore/results/soil_properties.py,sha256=Mcwz23PcaIW1xKLabMUSfIeKCTBli7ouuZPfT5dfrb4,20722
-py_pilecore-0.4.1.dist-info/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
-py_pilecore-0.4.1.dist-info/METADATA,sha256=oQzHxa-c_UofjtUdg5FCaFWsqvanEgxCxuAkn3M_A3g,5834
-py_pilecore-0.4.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-py_pilecore-0.4.1.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
-py_pilecore-0.4.1.dist-info/RECORD,,

pypilecore/input/pile_properties.py

@@ -1,213 +0,0 @@
-from __future__ import annotations
-
-
-def create_pile_properties_payload(
-    pile_type: str,
-    specification: str,
-    installation: str,
-    pile_shape: str,
-    diameter_base: float | None = None,
-    diameter_shaft: float | None = None,
-    width_base_large: float | None = None,
-    width_base_small: float | None = None,
-    width_shaft_large: float | None = None,
-    width_shaft_small: float | None = None,
-    height_base: float | None = None,
-    settlement_curve: float | None = None,
-    adhesion: float | None = None,
-    alpha_p: float | None = None,
-    alpha_s_clay: float | None = None,
-    alpha_s_sand: float | None = None,
-    beta_p: float | None = None,
-    pile_tip_factor_s: float | None = None,
-    elastic_modulus: float | None = None,
-    is_auger: float | None = None,
-    is_low_vibrating: float | None = None,
-    negative_fr_delta_factor: float | None = None,
-) -> dict:
-    """
-    Creates a dictionary with the `pile_properties` payload content for the PileCore
-    endpoints.
-
-    Note
-    ----
-    The dictionary should be converted to a jsonifyable message before it can be passed
-    to a `requests` call directly, for instance with
-    `nuclei.client.utils.python_types_to_message()`.
-
-    Parameters
-    ----------
-    pile_type:
-        The equaly named entry in the "pile_type_specification" settings.
-        Accepted values are: ["A","B","C""D","E","F","G"]
-    specification:
-        The equaly named entry in the "pile_type_specification" settings.
-        Accepted values are: ["concrete","steel","micro","wood"]
-    installation:
-        The equaly named entry in the "pile_type_specification" settings.
-        Accepted values are: ["1","2","3","4","5","6","7"]
-    pile_shape:
-        The shape of the pile.
-        Accepted values are: ["round", "rect"]
-    diameter_base:
-        Pile base diameter [m].
-        Only relevant if `shape`="round".
-    diameter_shaft:
-        Pile shaft diameter [m].
-        Only relevant if `shape`="round".
-    width_base_large:
-        Largest dimension of the pile base [m].
-        Only relevant if `shape`="rect".
-    width_base_small:
-        Smallest dimension of the pile base [m].
-        Only relevant if `shape`="rect".
-    width_shaft_large:
-        Largest dimension of the pile shaft [m].
-        Only relevant if `shape`="rect".
-    width_shaft_small:
-        Smallest dimension of the pile shaft [m].
-        Only relevant if `shape`="rect".
-    height_base:
-        Height of pile base [m]. If None, a pile with constant dimension is inferred.
-        Cannot be None if diameter_base and diameter_shaft are unequal.
-    settlement_curve:
-        Settlement lines for figures 7.n and 7.o of NEN-9997-1 As defined in table 7.c
-        of NEN-9997-1. The value is inferred from the pile_type_specifications, but can
-        be overwritten.
-    adhesion:
-        Optional adhesion value [kPa], use it if the pile shaft has undergone a special
-        treatment. Examples: - adhesion = 50 kN/m2 for synthetic coating - adhesion = 20
-        kN/m2 for bentonite - adhesion = 10 kN/m2 for bitumen coating See 7.3.2.2(d) of
-        NEN 9997-1 for examples.
-    alpha_p:
-        Alpha p factor used in pile tip resistance calculation. The value is inferred
-        from the pile_type_specifications, but can be overwritten.
-    alpha_s_clay:
-        Alpha s factor for soft layers used in the positive friction calculation. If
-        None the factor is determined as specified in table 7.d of NEN 9997-1.
-    alpha_s_sand:
-        Alpha s factor for coarse layers used in the positive friction calculation. The
-        value is inferred from the pile_type_specifications, but can be overwritten.
-    beta_p:
-        Factor s used in pile tip resistance calculation as per NEN 9997-1 7.6.2.3 (h).
-        The value is inferred from the pile dimension properties, but can be overwritten.
-    pile_tip_factor_s:
-        Factor s used in pile tip resistance calculation as per NEN 9997-1 7.6.2.3 (h).
-        The value is inferred from the pile dimension properties, but can be overwritten.
-    elastic_modulus:
-        Modulus of elasticity of the pile [Mpa]. The value is inferred from the
-        pile_type_specifications, but can be overwritten.
-    is_auger:
-        Determines weather the pile the pile is an auger pile or not. The value is
-        inferred from the pile_type_specifications, but can be overwritten.
-    is_low_vibrating:
-        Determines weather the pile has an installation type with low vibration. The
-        value is inferred from the pile_type_specifications, but can be overwritten.
-    negative_fr_delta_factor:
-        factor * φ = δ. This parameter will be multiplied with phi to get the delta
-        parameter used in negative friction calculation according to NEN-9997-1 7.3.2.2
-        (e). Typically values are 1.0 for piles cast in place, and 0.75 for other pile
-        types. The value is inferred from the pile_type_specifications, but can be
-        overwritten.
-
-    Returns
-    -------
-    pile_properties:
-        The `pile_properties` payload content of the PileCore-API endpoints.
-
-    Raises
-    ------
-    ValueError:
-        - if `pile_shape`=="round" & `diameter_base` is None
-        - if `pile_shape`=="rect" & `width_base_large` is None
-        - if `pile_shape` not in ["rect", "round"]
-    """
-    pile_properties: dict = dict(
-        props=dict(
-            pile_type_specification=dict(
-                pile_type=pile_type,
-                specification=specification,
-                installation=installation,
-            )
-        ),
-        type=pile_shape,
-    )
-
-    if pile_shape == "round":
-        if diameter_base is None:
-            raise ValueError(
-                'A value for `diameter_base` is required for `pile_shape`=="round"'
-            )
-
-        pile_properties["props"]["diameter_base"] = diameter_base
-
-        if diameter_shaft is not None:
-            if height_base is None:
-                raise ValueError(
-                    "A value for `height_base` is required when the base and shaft dimensions are unequal"
-                )
-
-            pile_properties["props"]["diameter_shaft"] = diameter_shaft
-
-    elif pile_shape == "rect":
-        if width_base_large is None:
-            raise ValueError(
-                'A value for `width_base_large` is required for `pile_shape`=="rect"'
-            )
-        pile_properties["props"]["width_base_large"] = width_base_large
-
-        if width_base_small is not None:
-            pile_properties["props"]["width_base_small"] = width_base_small
-
-        if (
-            width_shaft_large is not None or width_shaft_small is not None
-        ) and height_base is None:
-            raise ValueError(
-                "A value for `height_base` is required when the base and shaft dimensions are unequal"
-            )
-        if width_shaft_large is not None:
-            pile_properties["props"]["width_shaft_large"] = width_shaft_large
-
-        if width_shaft_small is not None:
-            pile_properties["props"]["width_shaft_small"] = width_shaft_small
-
-    else:
-        raise ValueError('pile_shape should be one of ["round", "rect"]')
-
-    if height_base is not None:
-        pile_properties["props"]["height_base"] = height_base
-
-    if settlement_curve is not None:
-        pile_properties["props"]["settlement_curve"] = settlement_curve
-
-    if adhesion is not None:
-        pile_properties["props"]["adhesion"] = adhesion
-
-    if alpha_p is not None:
-        pile_properties["props"]["alpha_p"] = alpha_p
-
-    if alpha_s_clay is not None:
-        pile_properties["props"]["alpha_s_clay"] = alpha_s_clay
-
-    if alpha_s_sand is not None:
-        pile_properties["props"]["alpha_s_sand"] = alpha_s_sand
-
-    if beta_p is not None:
-        pile_properties["props"]["beta_p"] = beta_p
-
-    if pile_tip_factor_s is not None:
-        pile_properties["props"]["pile_tip_factor_s"] = pile_tip_factor_s
-
-    if elastic_modulus is not None:
-        pile_properties["props"]["elastic_modulus"] = elastic_modulus
-
-    if is_auger is not None:
-        pile_properties["props"]["is_auger"] = is_auger
-
-    if is_low_vibrating is not None:
-        pile_properties["props"]["is_low_vibrating"] = is_low_vibrating
-
-    if negative_fr_delta_factor is not None:
-        pile_properties["props"]["negative_fr_delta_factor"] = negative_fr_delta_factor
-
-    return pile_properties