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

{py_pilecore-0.4.1.dist-info → py_pilecore-0.4.2.dist-info}/METADATA

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

{py_pilecore-0.4.1.dist-info → py_pilecore-0.4.2.dist-info}/RECORD

@@ -1,24 +1,24 @@
 pypilecore/__init__.py,sha256=T2Uuao6fboVhrzKI_Sa7jXbcNAUl_PKk9BFdsozOG98,78
-pypilecore/_version.py,sha256=0_HYvCjqXJ8bLPFLe6E2tkYlW15w7EOTtTD9FQ5jQGM,175
+pypilecore/_version.py,sha256=2dffVSzjhtY2kCEG85L-fZD3Xh0WRlG_TJVCqG9EfHc,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/multi_cpt.py,sha256=cYwsbxX-BFfDSmhOXiasm5TVQiWt4GQr0Q4jwYmcynI,19592
 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/multi_cpt_results.py,sha256=9unVE0sp25khcAhDM_CFRRgqg_SpTQCDW0L0hOtzxSg,30678
 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,,
+py_pilecore-0.4.2.dist-info/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
+py_pilecore-0.4.2.dist-info/METADATA,sha256=zeeDiTfTKJFa3I-TaPIKjFEayHGER0m2uKzd1FLRubM,5834
+py_pilecore-0.4.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+py_pilecore-0.4.2.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
+py_pilecore-0.4.2.dist-info/RECORD,,

pypilecore/_version.py

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

pypilecore/input/multi_cpt.py

@@ -313,9 +313,9 @@ def create_multi_cpt_payload(
         individual_ocr=individual_ocr,
     )
     pile_properties = create_pile_properties_payload(
-        pile_type=pile_type,
-        specification=specification,
-        installation=installation,
+        pile_type=str(pile_type),
+        specification=str(specification),
+        installation=str(installation),
         pile_shape=pile_shape,
         diameter_base=diameter_base,
         diameter_shaft=diameter_shaft,

pypilecore/results/multi_cpt_results.py

@@ -7,6 +7,7 @@ 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.exceptions import UserError
 from pypilecore.results.load_settlement import get_load_settlement_plot
@@ -548,6 +549,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),
+            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,