py-pilecore 0.5.1__py3-none-any.whl → 0.7.0__py3-none-any.whl

{py_pilecore-0.5.1.dist-info → py_pilecore-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-pilecore
-Version: 0.5.1
+Version: 0.7.0
 Summary: Public python SDK for the CEMS PileCore web-API.
 License: MIT License
         
@@ -37,7 +37,10 @@ Requires-Dist: matplotlib <4,>=3.8
 Requires-Dist: tqdm[notebook] <5,>4
 Requires-Dist: natsort <9,>8
 Requires-Dist: shapely <3,>=2
-Requires-Dist: scipy <2,>=1
+Requires-Dist: scipy <2,>=1.13
+Requires-Dist: ipywidgets <9,>=8
+Requires-Dist: dash <3,>=2.17
+Requires-Dist: plotly-geo <2,>=1.0.0
 Provides-Extra: docs
 Requires-Dist: Sphinx ==6.1.3 ; extra == 'docs'
 Requires-Dist: sphinx-autodoc-typehints ==1.22 ; extra == 'docs'
@@ -45,25 +48,20 @@ Requires-Dist: ipython ==8.11.0 ; extra == 'docs'
 Requires-Dist: asteroid-sphinx-theme ==0.0.3 ; extra == 'docs'
 Requires-Dist: sphinx-rtd-theme ==1.2.0 ; extra == 'docs'
 Provides-Extra: lint
-Requires-Dist: mypy ==1.6.1 ; extra == 'lint'
-Requires-Dist: mypy-extensions ==1.0.0 ; extra == 'lint'
-Requires-Dist: tomli ==2.0.1 ; extra == 'lint'
-Requires-Dist: typing-extensions ==4.7.1 ; extra == 'lint'
-Requires-Dist: black[jupyter] ==23.10.1 ; extra == 'lint'
-Requires-Dist: click ==8.1.3 ; extra == 'lint'
-Requires-Dist: packaging ==23.2 ; extra == 'lint'
-Requires-Dist: pathspec ==0.11.1 ; extra == 'lint'
-Requires-Dist: platformdirs ==3.5.1 ; extra == 'lint'
-Requires-Dist: isort ==5.12.0 ; extra == 'lint'
+Requires-Dist: ansible-lint ==6.22.1 ; extra == 'lint'
+Requires-Dist: black ==23.11.0 ; extra == 'lint'
+Requires-Dist: cfn-lint ==0.83.3 ; extra == 'lint'
+Requires-Dist: cpplint ==1.6.1 ; extra == 'lint'
 Requires-Dist: flake8 ==6.0.0 ; extra == 'lint'
-Requires-Dist: mccabe ==0.7.0 ; extra == 'lint'
-Requires-Dist: pycodestyle ==2.10.0 ; extra == 'lint'
-Requires-Dist: pyflakes ==3.0.1 ; extra == 'lint'
-Requires-Dist: pandas-stubs <3,>2 ; extra == 'lint'
-Requires-Dist: types-tqdm <5,>4 ; extra == 'lint'
+Requires-Dist: isort ==5.12.0 ; extra == 'lint'
+Requires-Dist: mypy ==1.7.1 ; extra == 'lint'
+Requires-Dist: sqlfluff ==2.3.5 ; extra == 'lint'
+Requires-Dist: yamllint ==1.33.0 ; extra == 'lint'
+Requires-Dist: yq ==3.2.3 ; extra == 'lint'
 Provides-Extra: test
 Requires-Dist: coveralls ; extra == 'test'
 Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: openapi-core ; extra == 'test'
 
 # py-pilecore
 Public python SDK for the CEMS PileCore web-API
@@ -99,7 +97,7 @@ Go to `personal-access-tokens` and create a new user token.
 
 ## Environment
 
-We recommend developing in Python3.10 with a clean virtual environment (using `virtualenv` or `conda`), installing the requirements from the requirements.txt file:
+We recommend developing in Python3.11 with a clean virtual environment (using `virtualenv` or `conda`), installing the requirements from the requirements.txt file:
 
 Example using `virtualenv` and `pip` to install the dependencies in a new environment .env on Linux:
 
@@ -151,7 +149,7 @@ coverage run -m pytest
 
 ## Requirements
 
-Requirements are autogenerated by the `pip-compile` command with python 3.10
+Requirements are autogenerated by the `pip-compile` command with python 3.11
 
 Install pip-tools with:
 

{py_pilecore-0.5.1.dist-info → py_pilecore-0.7.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 pypilecore/__init__.py,sha256=oJvwYShj_7FyNVlUgQda4tTdYyLIi5H1asdiS_uYt9M,162
-pypilecore/_version.py,sha256=qHUIQ-gDL6kMjSnoprXjr-A8s8rwQzYqD2YFXvLDtHs,175
+pypilecore/_version.py,sha256=MCrXa9Xoh2jGlyzUGX0O346XcUwgg1UzXaK6GJAguWs,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
@@ -16,18 +16,29 @@ pypilecore/common/piles/geometry/components/common.py,sha256=scYoF-4aE0Wknx9GgSO
 pypilecore/common/piles/geometry/components/rectangle.py,sha256=591KyIejyjNAMnKg8yThFjbrPXAVHQdf08vaiQYHZdk,18411
 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=qOc-SNYSPdOcZZ9DsRE-sBNVOKHbUD044EWRsWDu_kc,10893
+pypilecore/input/grouper_properties.py,sha256=4Rhea8pnrbWqIIiplHdPS-EioDRurCcLe6thHkGkBEM,11146
 pypilecore/input/multi_cpt.py,sha256=V7A_MAYeJoMkGOQu1oFGJfJ3dkuBdhDSfeLvgiCLmqs,14196
-pypilecore/input/soil_properties.py,sha256=VZHGGmns768XPLjMTVwQDpy3f0LDFG0AwbKVfm3xKWc,7993
-pypilecore/results/__init__.py,sha256=ggTI2QzILhX_oNx1YMOih6IVCkBFg8I5-Jyn9Sw3_h0,389
+pypilecore/input/soil_properties.py,sha256=ms2zxRPK_0zJAgei4QTJhC71Y7ivUguqoRTDUzuqyl8,8277
+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
 pypilecore/results/load_settlement.py,sha256=EbfTrSvH_g96KE-x8ZjmO8D0mt5KFaQ_-AR8u4blLsU,9752
 pypilecore/results/multi_cpt_results.py,sha256=dCV2VTRuReCt8J1MAfjqgboq2nNJ7r2OPPJ9DqTp4Io,30943
 pypilecore/results/post_processing.py,sha256=UWXcdff5dhPFDwzKbVIayEIp3HX6pxW8oQR3Z7AHPn0,22262
+pypilecore/results/result_definitions.py,sha256=Nb6AaJ6n5bVeC5awB1h-HO43_pknFVAZm-g5Zr8fpBU,8027
 pypilecore/results/single_cpt_results.py,sha256=37zzsAO60JQX44cbqHoZgkdGdGIC_HvxM9em-oldo7o,17459
 pypilecore/results/soil_properties.py,sha256=UfPdB3L1fCjp7iDr7b0iUs_RDBi8WhSPngF8rtfxqdo,20744
-py_pilecore-0.5.1.dist-info/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
-py_pilecore-0.5.1.dist-info/METADATA,sha256=OfOdXssrUV1zAUbyIVrqUhTY8O3wl9G9zaPDZPB8Z6o,5832
-py_pilecore-0.5.1.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
-py_pilecore-0.5.1.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
-py_pilecore-0.5.1.dist-info/RECORD,,
+pypilecore/viewers/__init__.py,sha256=GjPAj7O_L5QsK2fhewi7yd5fZnbYeCvauDAD37I20Rg,330
+pypilecore/viewers/viewer_cpt_group_results.py,sha256=iVwvm4JZeJ9v3r9Q5uWBAYJ7RQaYkQF0WOX0uUFMTgo,2530
+pypilecore/viewers/viewer_cpt_results.py,sha256=EN9Qq8gGdvIz9rTuazmtVwLyI6NqcuzHv1gz2S3sgng,2956
+pypilecore/viewers/viewer_cpt_results_plan_view.py,sha256=J1KOyUiG0tJJdpTAdEKYM-7aBhp9Kh4l-ceZnoOfqsA,3647
+pypilecore/viewers/interactive_figures/__init__.py,sha256=u6fkLqDB35J2bdGvUewzRC8UEQUFF6AoXxR-_v8AX0A,481
+pypilecore/viewers/interactive_figures/figure_cpt_group_results_versus_ptls.py,sha256=RzNOYQmP_yT8oYeIMW9aYNl7aAKU-uFQfygxP9AwDsU,6471
+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=Wl5hNsTdgh6wPm_sVGg1bfKamHzGnVNpuepgOg-oOFY,1582
+py_pilecore-0.7.0.dist-info/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
+py_pilecore-0.7.0.dist-info/METADATA,sha256=aBHbPcfhifQUyeFmdyn5cg5C6H3ZSnCbe17THb9VBzI,5653
+py_pilecore-0.7.0.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
+py_pilecore-0.7.0.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
+py_pilecore-0.7.0.dist-info/RECORD,,

{py_pilecore-0.5.1.dist-info → py_pilecore-0.7.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.2)
+Generator: setuptools (75.1.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.5.1"
+    __version__ = "0.7.0"

pypilecore/input/grouper_properties.py

@@ -74,7 +74,8 @@ def create_grouper_payload(
     Parameters
     ----------
     cpt_results_dict:
-        Dictionary with key as CPT name and value a SingleCPTBearingResults class
+        Dictionary with key as CPT name and value a SingleCPTBearingResults class.
+        Should contain at least 2 entries.
     pile_load_uls
         ULS load in kN. Used to determine if a grouping configuration is valid.
     stiff_construction
@@ -131,12 +132,12 @@ def create_grouper_payload(
     ValueError:
         - if NaN values are present in negative friction, bottom or shaft bearing_capacity
 
-
         - if x or y coordinate is None
 
-
         - if pile tip levels don't macht for all SingleCPTBearingResults
 
+        - if less than 2 valid CPTs are provided
+
 
     Returns
     -------
@@ -212,6 +213,12 @@ def create_grouper_payload(
                 },
             }
         )
+
+    if not len(cpt_objects) >= 2:
+        raise ValueError(
+            "The PileCore grouper requires at least 2 CPTs with valid bearing capacity."
+        )
+
     payload["cpt_objects"] = cpt_objects
 
     # validate pile tip levels

pypilecore/input/soil_properties.py

@@ -158,9 +158,19 @@ def create_soil_properties_payload(
             groundwater_level_nap=groundwater_level_nap
             if groundwater_level_nap is not None
             else cpt.delivered_vertical_position_offset - 1,
-            coordinates=dict(x=cpt.delivered_location.x, y=cpt.delivered_location.y),
         )
 
+        # Optionally add coordinates
+        if (
+            cpt.delivered_location is not None
+            and cpt.delivered_location.x is not None
+            and cpt.delivered_location.y is not None
+        ):
+            soil_properties["coordinates"] = {
+                "x": cpt.delivered_location.x,
+                "y": cpt.delivered_location.y,
+            }
+
         # Optionally add cpt-specific friction-range parameters
         if (
             individual_negative_friction_range_nap is not None

pypilecore/results/__init__.py

@@ -1,9 +1,11 @@
+from pypilecore.results.cases_multi_cpt_results import CasesMultiCPTBearingResults
 from pypilecore.results.grouper_result import GrouperResults
 from pypilecore.results.multi_cpt_results import MultiCPTBearingResults
 from pypilecore.results.single_cpt_results import SingleCPTBearingResults
 from pypilecore.results.soil_properties import SoilProperties
 
 __all__ = [
+    "CasesMultiCPTBearingResults",
     "MultiCPTBearingResults",
     "SingleCPTBearingResults",
     "SoilProperties",

pypilecore/results/cases_multi_cpt_results.py

@@ -0,0 +1,244 @@
+from __future__ import annotations  # noqa: F404
+
+from typing import Dict, Hashable, List
+
+import pandas as pd
+from natsort import natsorted
+from pygef.common import Location
+
+from pypilecore.results.multi_cpt_results import MultiCPTBearingResults
+from pypilecore.results.result_definitions import (
+    CPTGroupResultDefinitions,
+    CPTResultDefinitions,
+)
+
+
+class CasesMultiCPTBearingResults:
+    """
+    Container class for the results of multiple cases of MultiCPTBearingResults.
+    It expects that all MultiCPTBearingResults objects have the same pile tip levels and same test ids.
+    """
+
+    def __init__(
+        self,
+        results_per_case: Dict[Hashable, MultiCPTBearingResults],
+        cpt_locations: Dict[str, Location],
+    ) -> None:
+        """
+        Initialize the class with the results of multiple cases of MultiCPTBearingResults.
+
+        Parameters
+        ----------
+        results_per_case : Dict[Hashable, MultiCPTBearingResults]
+            A dictionary with the results of multiple cases of MultiCPTBearingResults.
+            The keys of the dictionary are the case names.
+            All MultiCPTBearingResults objects must have the same pile tip levels and same test ids.
+        cpt_locations : Dict[str, Location]
+            The mapping between `test_id` (key) and the `location` (value) of the cpt.
+            The keys must contain all the `test_id` (s) used in the MultiCPTBearingResults objects.
+
+        Raises
+        ------
+        TypeError
+            If `results_per_case` is not of the expected type.
+            If `cpt_locations` is not of the expected type.
+        ValueError
+            If `results_per_case` is an empty dictionary.
+            If not all MultiCPTBearingResults objects have the same pile tip levels and test ids.
+            If not all the `test_id` (s) used in the MultiCPTBearingResults objects are in the keys of `cpt_locations`.
+        """
+        # Validate results cases
+        _validate_results_per_case(results_per_case)
+
+        # Initialize private variables
+        self._cases = natsorted(list(results_per_case.keys()))
+        self._multicpt_bearing_results = [results_per_case[c] for c in self.cases]
+        self._test_ids = natsorted(
+            results_per_case[list(results_per_case.keys())[0]].cpt_results.test_ids
+        )
+        self._pile_tip_levels_nap = sorted(
+            list(
+                results_per_case[list(results_per_case.keys())[0]]
+                .cpt_results.to_pandas()
+                .pile_tip_level_nap.unique()
+            ),
+            reverse=True,
+        )
+        self._set_cpt_locations(cpt_locations)
+
+        # Create cpt_results_dataframe and cpt_group_results_dataframe
+        self._set_cpt_results_dataframe(results_per_case)
+        self._set_cpt_group_results_dataframe(results_per_case)
+
+    def _set_cpt_results_dataframe(
+        self, results_per_case: Dict[Hashable, MultiCPTBearingResults]
+    ) -> None:
+        """Private method to create and set the property `cpt_results_dataframe`."""
+        records = []
+        for case_name, case_results in results_per_case.items():
+            for result_definition in CPTResultDefinitions:
+                df = case_results.cpt_results.get_results_per_cpt(
+                    column_name=result_definition.name
+                )
+                for idx_row, row in df.iterrows():
+                    for test_id, result in row.items():
+                        records.append(
+                            dict(
+                                case_name=case_name,
+                                result_name=result_definition.name,
+                                test_id=test_id,
+                                x=self.cpt_locations[test_id].x,
+                                y=self.cpt_locations[test_id].y,
+                                pile_tip_level_nap=idx_row,
+                                result=result,
+                                result_unit=result_definition.value.unit,
+                            )
+                        )
+        self._cpt_results_dataframe = pd.DataFrame.from_records(records)
+
+    def _set_cpt_group_results_dataframe(
+        self, result_cases: Dict[Hashable, MultiCPTBearingResults]
+    ) -> None:
+        """Private method to create and set the property `cpt_group_results_dataframe`."""
+        records = []
+        for case_name, case_results in result_cases.items():
+            df = case_results.group_results_table.to_pandas()
+            for result_definition in CPTGroupResultDefinitions:
+                for _, row in df.iterrows():
+                    records.append(
+                        dict(
+                            case_name=case_name,
+                            result_name=result_definition.name,
+                            pile_tip_level_nap=row["pile_tip_level_nap"],
+                            result=row[result_definition.value.name],
+                            result_unit=result_definition.value.unit,
+                        )
+                    )
+        self._cpt_group_results_dataframe = pd.DataFrame.from_records(records)
+
+    def _set_cpt_locations(self, value: Dict[str, Location]) -> None:
+        """Private setter for `cpt_locations`."""
+        # Check data types
+        if not isinstance(value, dict):
+            raise TypeError(
+                f"Expected type 'List[CPTData]' for 'cpt_locations', but got {type(value)}"
+            )
+
+        if not all(isinstance(k, str) for k in value.keys()):
+            raise TypeError(
+                f"Expected type 'str' for keys of 'cpt_locations', but got {(type(k) for k in value.keys())}"
+            )
+
+        if not all(isinstance(v, Location) for v in value.values()):
+            raise TypeError(
+                f"Expected type 'Location' for values of 'cpt_locations', but got {(type(v) for v in value.values())}"
+            )
+
+        # Check that all the `test_id`s used in the MultiCPTBearingResults objects are in the keys.
+        if not all(test_id in value.keys() for test_id in self.test_ids):
+            missing_test_ids = [
+                test_id for test_id in self.test_ids if test_id not in value.keys()
+            ]
+            raise ValueError(
+                "Not all `test_id`s used in the MultiCPTBearingResults objects are in the keys of `cpt_locations`. "
+                + f"The following `test_id`s are missing: {missing_test_ids}"
+            )
+
+        self._cpt_locations = value
+
+    @property
+    def cases(self) -> List[Hashable]:
+        """The case names."""
+        return self._cases
+
+    @property
+    def multicpt_bearing_results(self) -> List[MultiCPTBearingResults]:
+        """The MultiCPTBearingResults objects."""
+        return self._multicpt_bearing_results
+
+    @property
+    def test_ids(self) -> List[str]:
+        """The test ids of all MultiCPTBearingResults objects."""
+        return self._test_ids
+
+    @property
+    def pile_tip_levels_nap(self) -> List[float]:
+        """The pile tip levels NAP of all MultiCPTBearingResults objects."""
+        return self._pile_tip_levels_nap
+
+    @property
+    def cpt_locations(self) -> Dict[str, Location]:
+        """The mapping between `test_id` (key) and the `location` (value) of the cpt."""
+        return self._cpt_locations
+
+    @property
+    def cpt_results_dataframe(self) -> pd.DataFrame:
+        """
+        The dataframe with all the CPT results.
+        Available columns: case_name, result_name, test_id, x, y, pile_tip_level_nap, result, result_unit.
+        """
+        return self._cpt_results_dataframe
+
+    @property
+    def cpt_group_results_dataframe(self) -> pd.DataFrame:
+        """
+        The dataframe with CPT group results.
+        Available columns: case_name, result_name, pile_tip_level_nap, result, result_unit.
+        """
+        return self._cpt_group_results_dataframe
+
+
+def _validate_results_per_case(
+    results_per_case: Dict[Hashable, MultiCPTBearingResults]
+) -> None:
+    """
+    Private method to validate the results_per_case dictionary.
+
+    Parameters
+    ----------
+    results_per_case : Dict[Hashable, MultiCPTBearingResults]
+        A dictionary with the results of multiple cases of MultiCPTBearingResults.
+        The keys of the dictionary are the case names.
+        All MultiCPTBearingResults objects must have the same pile tip levels and same test ids.
+
+    Raises
+    ------
+    TypeError
+        If `results_per_case` is not of the expected type.
+    ValueError
+        If `results_per_case` is an empty dictionary.
+        If not all MultiCPTBearingResults objects have the same pile tip levels and test ids.
+    """
+    if not isinstance(results_per_case, dict):
+        raise TypeError(
+            f"Expected type 'Dict[Hashable, MultiCPTBearingResults]' for 'results_per_case', but got {type(results_per_case)}"
+        )
+
+    if len(results_per_case) == 0:
+        raise ValueError("Empty dictionary 'results_per_case' is not allowed.")
+
+    for val in results_per_case.values():
+        if not isinstance(val, MultiCPTBearingResults):
+            raise TypeError(
+                f"Expected type 'MultiCPTBearingResults' for items in 'results_per_case', but got {type(val)}"
+            )
+
+    test_ids = results_per_case[list(results_per_case.keys())[0]].cpt_results.test_ids
+    pile_tip_levels_nap = list(
+        results_per_case[list(results_per_case.keys())[0]]
+        .cpt_results.to_pandas()
+        .pile_tip_level_nap.unique()
+    )
+    for results in results_per_case.values():
+        if results.cpt_results.test_ids != test_ids:
+            raise ValueError(
+                "All MultiCPTBearingResults objects must have the same test ids."
+            )
+
+        if (
+            list(results.cpt_results.to_pandas().pile_tip_level_nap.unique())
+            != pile_tip_levels_nap
+        ):
+            raise ValueError(
+                "All MultiCPTBearingResults objects must have the same pile tip levels."
+            )

pypilecore/results/result_definitions.py

@@ -0,0 +1,195 @@
+from __future__ import annotations  # noqa: F404
+
+from dataclasses import dataclass
+from enum import Enum
+from typing import List
+
+from natsort import natsorted
+
+
+@dataclass
+class ResultDefinition:
+    """
+    Dataclass containing the name, units and html representation of a result.
+    """
+
+    name: str
+    """The name of the result."""
+    unit: str
+    """The unit of the result."""
+    html: str
+    """The html representation of the result"""
+
+    def __post_init__(self) -> None:
+        """
+        Method to validate the input types of the dataclass.
+
+        Raises
+        ------
+        ValueError
+            If the input types are not correct.
+        """
+        if not isinstance(self.name, str):
+            raise TypeError(
+                f"Expected type 'str' for 'name', but got {type(self.name)}"
+            )
+        if not isinstance(self.unit, str):
+            raise TypeError(
+                f"Expected type 'str' for 'unit', but got {type(self.unit)}"
+            )
+
+        if not isinstance(self.html, str):
+            raise TypeError(
+                f"Expected type 'str' for 'html', but got {type(self.html)}"
+            )
+
+
+class CPTResultDefinitions(Enum):
+    """
+    Enumeration of available CPT result definitions.
+    """
+
+    F_nk_cal = ResultDefinition(name="F_nk_cal", unit="kN", html="F<sub>nk;cal</sub>")
+    F_nk_k = ResultDefinition(name="F_nk_k", unit="kN", html="F<sub>nk;k</sub>")
+    F_nk_d = ResultDefinition(name="F_nk_d", unit="kN", html="F<sub>nk;d</sub>")
+    R_b_cal = ResultDefinition(name="R_b_cal", unit="kN", html="R<sub>b;cal</sub>")
+    R_b_k = ResultDefinition(name="R_b_k", unit="kN", html="R<sub>b;k</sub>")
+    R_b_d = ResultDefinition(name="R_b_d", unit="kN", html="R<sub>b;d</sub>")
+    R_s_cal = ResultDefinition(name="R_s_cal", unit="kN", html="R<sub>s;cal</sub>")
+    R_s_k = ResultDefinition(name="R_s_k", unit="kN", html="R<sub>s;k</sub>")
+    R_s_d = ResultDefinition(name="R_s_d", unit="kN", html="R<sub>s;d</sub>")
+    R_c_cal = ResultDefinition(name="R_c_cal", unit="kN", html="R<sub>c;cal</sub>")
+    R_c_k = ResultDefinition(name="R_c_k", unit="kN", html="R<sub>c;k</sub>")
+    R_c_d = ResultDefinition(name="R_c_d", unit="kN", html="R<sub>c;d</sub>")
+    R_c_d_net = ResultDefinition(
+        name="R_c_d_net",
+        unit="kN",
+        html="R<sub>c;d;net</sub>",
+    )
+    F_c_k = ResultDefinition(name="F_c_k", unit="kN", html="F<sub>c;k</sub>")
+    F_c_k_tot = ResultDefinition(
+        name="F_c_k_tot",
+        unit="kN",
+        html="F<sub>c;k;tot</sub>",
+    )
+    negative_friction_range_nap_top = ResultDefinition(
+        name="negative_friction_range_nap_top",
+        unit="m NAP",
+        html="Top of negative friction",
+    )
+    negative_friction_range_nap_btm = ResultDefinition(
+        name="negative_friction_range_nap_btm",
+        unit="m NAP",
+        html="Bottom of negative friction",
+    )
+    positive_friction_range_nap_top = ResultDefinition(
+        name="positive_friction_range_nap_top",
+        unit="m NAP",
+        html="Top of positive friction",
+    )
+    positive_friction_range_nap_btm = ResultDefinition(
+        name="positive_friction_range_nap_btm",
+        unit="m NAP",
+        html="Bottom of positive friction",
+    )
+    q_b_max = ResultDefinition(name="q_b_max", unit="MPa", html="q<sub>b;max</sub>")
+    q_s_max_mean = ResultDefinition(
+        name="q_s_max_mean",
+        unit="MPa",
+        html="q<sub>s;max</sub>",
+    )
+    qc1 = ResultDefinition(name="qc1", unit="MPa", html="q<sub>c1</sub>")
+    qc2 = ResultDefinition(name="qc2", unit="MPa", html="q<sub>c2</sub>")
+    qc3 = ResultDefinition(name="qc3", unit="MPa", html="q<sub>c3</sub>")
+    s_b = ResultDefinition(name="s_b", unit="mm", html="s<sub>b</sub>")
+    s_el = ResultDefinition(name="s_el", unit="mm", html="s<sub>el</sub>")
+    k_v_b = ResultDefinition(name="k_v_b", unit="MN/m", html="k<sub>v;b</sub>")
+    k_v_1 = ResultDefinition(name="k_v_1", unit="MN/m", html="k<sub>v;1</sub>")
+
+    @classmethod
+    def get(cls, name: str) -> CPTResultDefinitions:
+        """Returns the result definition the given name."""
+        try:
+            return cls[name]
+        except KeyError:
+            raise ValueError(
+                f"Result with name '{name}' not found in 'CPTResultDefinitions'."
+            )
+
+    @classmethod
+    def natsorted_names(cls) -> List[str]:
+        """Returns the names of the enum in natsorted order."""
+        return natsorted([r.name for r in cls])
+
+
+class CPTGroupResultDefinitions(Enum):
+    R_s_k = ResultDefinition(name="R_s_k", unit="kN", html="R<sub>s;k</sub>")
+    R_b_k = ResultDefinition(name="R_b_k", unit="kN", html="R<sub>b;k</sub>")
+    R_c_k = ResultDefinition(name="R_c_k", unit="kN", html="R<sub>c;k</sub>")
+    R_s_d = ResultDefinition(name="R_s_d", unit="kN", html="R<sub>s;d</sub>")
+    R_b_d = ResultDefinition(name="R_b_d", unit="kN", html="R<sub>b;d</sub>")
+    R_c_d = ResultDefinition(name="R_c_d", unit="kN", html="R<sub>c;d</sub>")
+    F_nk_cal_mean = ResultDefinition(
+        name="F_nk_cal_mean", unit="kN", html="F<sub>nk;cal;mean</sub>"
+    )
+    F_nk_k = ResultDefinition(name="F_nk_k", unit="kN", html="F<sub>nk;k</sub>")
+    F_nk_d = ResultDefinition(name="F_nk_d", unit="kN", html="F<sub>nk;d</sub>")
+    R_c_d_net = ResultDefinition(
+        name="R_c_d_net",
+        unit="kN",
+        html="R<sub>c;d;net</sub>",
+    )
+    F_c_k = ResultDefinition(name="F_c_k", unit="kN", html="F<sub>c;k</sub>")
+    F_c_k_tot = ResultDefinition(
+        name="F_c_k_tot",
+        unit="kN",
+        html="F<sub>c;k;tot</sub>",
+    )
+    s_b = ResultDefinition(name="s_b", unit="mm", html="s<sub>b</sub>")
+    s_e = ResultDefinition(name="s_e", unit="mm", html="s<sub>e</sub>")
+    s_e_mean = ResultDefinition(name="s_e_mean", unit="mm", html="s<sub>e;mean</sub>")
+    R_b_mob_ratio = ResultDefinition(
+        name="R_b_mob_ratio", unit="-", html="R<sub>b;mob;ratio</sub>"
+    )
+    R_s_mob_ratio = ResultDefinition(
+        name="R_s_mob_ratio", unit="-", html="R<sub>s;mob;ratio</sub>"
+    )
+    k_v_b = ResultDefinition(name="k_v_b", unit="MN/m", html="k<sub>v;b</sub>")
+    k_v_1 = ResultDefinition(name="k_v_1", unit="MN/m", html="k<sub>v;1</sub>")
+    R_c_min = ResultDefinition(name="R_c_min", unit="kN", html="R<sub>c;min</sub>")
+    R_c_max = ResultDefinition(name="R_c_max", unit="kN", html="R<sub>c;max</sub>")
+    R_c_mean = ResultDefinition(name="R_c_mean", unit="kN", html="R<sub>c;mean</sub>")
+    R_c_std = ResultDefinition(name="R_c_std", unit="kN", html="R<sub>c;std</sub>")
+    R_s_mean = ResultDefinition(name="R_s_mean", unit="kN", html="R<sub>s;mean</sub>")
+    R_b_mean = ResultDefinition(name="R_b_mean", unit="kN", html="R<sub>b;mean</sub>")
+    var_coef = ResultDefinition(name="var_coef", unit="%", html="Variation coefficient")
+    n_cpts = ResultDefinition(name="n_cpts", unit="-", html="Number of CPTs")
+    use_group_average = ResultDefinition(
+        name="use_group_average", unit="-", html="Use group average"
+    )
+    xi_normative = ResultDefinition(name="xi_normative", unit="-", html="Normative ξ")
+    xi_value = ResultDefinition(name="xi_value", unit="-", html="ξ<sub>value</sub>")
+    cpt_Rc_min = ResultDefinition(
+        name="cpt_Rc_min", unit="-", html="CPT with R<sub>c;min</sub>"
+    )
+    cpt_Rc_max = ResultDefinition(
+        name="cpt_Rc_max", unit="-", html="CPT with R<sub>c;max</sub>"
+    )
+    cpt_normative = ResultDefinition(
+        name="cpt_normative", unit="-", html="Normative CPT"
+    )
+
+    @classmethod
+    def get(cls, name: str) -> CPTGroupResultDefinitions:
+        """Returns the result definition given the name."""
+        try:
+            return cls[name]
+        except KeyError:
+            raise ValueError(
+                f"Result with name '{name}' not found in 'CPTGroupResultDefinitions'."
+            )
+
+    @classmethod
+    def natsorted_names(cls) -> List[str]:
+        """Returns the names of the enum in natsorted order."""
+        return natsorted([r.name for r in cls])

pypilecore/viewers/__init__.py

@@ -0,0 +1,9 @@
+from pypilecore.viewers.viewer_cpt_group_results import ViewerCptGroupResults
+from pypilecore.viewers.viewer_cpt_results import ViewerCptResults
+from pypilecore.viewers.viewer_cpt_results_plan_view import ViewerCptResultsPlanView
+
+__all__ = [
+    "ViewerCptResults",
+    "ViewerCptResultsPlanView",
+    "ViewerCptGroupResults",
+]