py-pilecore 1.0.2__py3-none-any.whl → 1.0.4__py3-none-any.whl

{py_pilecore-1.0.2.dist-info → py_pilecore-1.0.4.dist-info}/METADATA

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

{py_pilecore-1.0.2.dist-info → py_pilecore-1.0.4.dist-info}/RECORD

@@ -1,6 +1,6 @@
-py_pilecore-1.0.2.dist-info/licenses/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
+py_pilecore-1.0.4.dist-info/licenses/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
 pypilecore/__init__.py,sha256=oJvwYShj_7FyNVlUgQda4tTdYyLIi5H1asdiS_uYt9M,162
-pypilecore/_version.py,sha256=_rwWTWwSBaaR-pQJfJGXpvM5hd8P4tPjyR6kiEQyylk,175
+pypilecore/_version.py,sha256=jnzhNYs6bqTiyDu0QEsVMOEnDNnEsaMyuGkSRaAqPJ8,175
 pypilecore/api.py,sha256=U41P6_N5ihwIv91kayrI7cs_KTo2M5HfJGqO6K6aJVE,9959
 pypilecore/exceptions.py,sha256=-MZOfsxyHLCI0k1-wZFfVsMxc1lya5buuhLks5rxlCo,89
 pypilecore/plot_utils.py,sha256=rK5_067-4-x7LzZgt_t6ahcGrZInxNrqHqsy0RzCnq8,954
@@ -8,7 +8,7 @@ pypilecore/utils.py,sha256=ib9LgJBIgWukL7zd_Zk1LP27UTMIZTRJ4RBB6ubn97o,1186
 pypilecore/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pypilecore/common/piles/__init__.py,sha256=wyAI8cxs_FvCOR7R7vsAhN-o9vfI9vx6M68ufVPpLvc,177
 pypilecore/common/piles/grid.py,sha256=u38mMbPo-Tg8AA5_vfniU_rNvPkUaNCLs7cKRTFBDlQ,7258
-pypilecore/common/piles/main.py,sha256=thLtCis7cZBz43SeZ7nyHUHT7Z0bBvnMdD0yFtzcbnM,12357
+pypilecore/common/piles/main.py,sha256=1zPtVEZAmWdKu3Nvm2LOUbDrr0DTHxrpAC9AwAgKGkY,15171
 pypilecore/common/piles/type.py,sha256=WDN43-aCZsDJ10B_Y3C_38fY3zLNJbAXhpPsKMJp_JM,10686
 pypilecore/common/piles/geometry/__init__.py,sha256=dFCVazEXnPCt5cQeHkSi5wp-yHRB9gKvtlQ3V5kBuOQ,438
 pypilecore/common/piles/geometry/main.py,sha256=ant3y1ZTGRN2off5-dwz2024Xa7pC0K7auBbmjTy9p8,11231
@@ -19,8 +19,8 @@ pypilecore/common/piles/geometry/components/rectangle.py,sha256=591KyIejyjNAMnKg
 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=mCJ590bS-tDKUgxJW_LIzIEtoMrYAQiE48rJb6QwNsY,11168
-pypilecore/input/multi_cpt.py,sha256=b5poixEs5ex8WGcu3rJiFMdS5Q4DE807L6jmeqiFE64,17506
-pypilecore/input/soil_properties.py,sha256=WympKatXyGKr6IL4RhW-sUKOKov2wV_0Wq9YkdBAQgs,9968
+pypilecore/input/multi_cpt.py,sha256=QKhEWzNVnPe7C8OSSSj1z3XNgQ7Z5RG7J9SnK9gM4rE,18598
+pypilecore/input/soil_properties.py,sha256=Uh6rFUZUPMzFyQI9yon9PMMwOn8lAUZVa_XHx3AC-5Y,10142
 pypilecore/input/tension.py,sha256=wbVAs3maYbUDzarq_DOQSR00QYVDh4Mkbaxb-hz4E08,11921
 pypilecore/results/__init__.py,sha256=UCMRRVNZxHTtTD4yTrJ-vpHy-Pga8vvxRu45d8pu5DM,844
 pypilecore/results/cases_multi_cpt_results.py,sha256=meCqFDBCGiSwgmwSzvTLxF5Z0HYkKK-LKrvDp5rAUy8,10253
@@ -43,7 +43,7 @@ pypilecore/viewers/interactive_figures/figure_cpt_group_results_versus_ptls.py,s
 pypilecore/viewers/interactive_figures/figure_cpt_results_plan_view.py,sha256=6je5ALYihQ_9bMbT_rinByCgHfQ61dWB6zzDhiL_iCQ,9380
 pypilecore/viewers/interactive_figures/figure_cpt_results_versus_ptls.py,sha256=Kaaw1HT4d-fA5DJzvBHbE3yg-I-fWzxhE8gUxfPWahU,6046
 pypilecore/viewers/interactive_figures/utils.py,sha256=B2X8hbbmJqjm8E2VrS2EoX5F1yQ5qOQnQUG_vbsseT8,1692
-py_pilecore-1.0.2.dist-info/METADATA,sha256=olPy9njwXecMcCuFxRjGrKEfPsvHkd97rfJsToLH3J8,5970
-py_pilecore-1.0.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-py_pilecore-1.0.2.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
-py_pilecore-1.0.2.dist-info/RECORD,,
+py_pilecore-1.0.4.dist-info/METADATA,sha256=0iaVPSY9tdplCUQgkIqiYzahxvr6G2OlJUJkNCXC7fM,5970
+py_pilecore-1.0.4.dist-info/WHEEL,sha256=wXxTzcEDnjrTwFYjLPcsW_7_XihufBwmpiBeiXNBGEA,91
+py_pilecore-1.0.4.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
+py_pilecore-1.0.4.dist-info/RECORD,,

{py_pilecore-1.0.2.dist-info → py_pilecore-1.0.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.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__ = "1.0.2"
+    __version__ = "1.0.4"

pypilecore/common/piles/main.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Dict, List
+from typing import Dict, List, Literal
 
 from pypilecore.common.piles.geometry import PileGeometry
 from pypilecore.common.piles.geometry.components import (
@@ -91,9 +91,9 @@ class PileProperties:
 
 
 def create_basic_pile(
-    pile_shape: str,
+    pile_shape: Literal["round", "rect", "rectangle"],
     pile_name: str | None = None,
-    main_type: str | None = None,
+    main_type: Literal["concrete", "steel", "wood", "anchor"] | None = None,
     specification: str | int | float | None = None,
     installation: str | None = None,
     height_base: float | None = None,
@@ -103,7 +103,8 @@ def create_basic_pile(
     base_tertiary_dimension: float | None = None,
     core_diameter: float | None = None,
     base_diameter: float | None = None,
-    pile_material: str | None = None,
+    pile_material: Literal["concrete", "steel", "wood", "grout", "grout_extorted"]
+    | None = None,
     custom_material: dict | None = None,
     settlement_curve: int | None = None,
     adhesion: float | None = None,
@@ -129,91 +130,141 @@ def create_basic_pile(
 
     Parameters
     ----------
-    pile_shape : str
-        The shape of the pile. Either "round" or "rect".
-    pile_name : str, optional
+    pile_shape :
+        The shape of the pile.
+        Both "rect" and "rectangle" are accepted for rectangular piles.
+    pile_name :
         The name of the pile, by default None.
-    main_type : str, optional
+    main_type :
         The main type of the standard pile type definition, by default None.
-    specification : str | int | float, optional
+    specification :
         The specification of the standard pile type definition, by default None.
         Required if `main_type` is provided.
-    installation : str, optional
+    installation :
         The installation of the standard pile type definition, by default None.
-    height_base : float, optional
+    height_base :
         The height [m] of the base component, by default None.
         Required if base dimensions are provided.
-    core_secondary_dimension : float, optional
-        The largest dimension [m] of the core component's cross-section, by default None.
+    core_secondary_dimension :
+        The largest dimension [m] of the rectangular core component's cross-section, by default None.
         Required for rectangular piles.
-    core_tertiary_dimension : float, optional
-        The smallest dimension [m] of the core component's cross-section, by default None.
-    base_secondary_dimension : float, optional
-        The largest dimension [m] of the base/shell component's cross-section, by default None.
-    base_tertiary_dimension : float, optional
-        The smallest dimension [m] of the base/shell component's cross-section, by default None.
-    core_diameter : float, optional
-        The diameter [m] of the core component's cross-section, by default None.
+    core_tertiary_dimension :
+        The smallest dimension [m] of the rectangular core component's cross-section, by default None.
+        If None and pile shape is rectangular, `core_tertiary_dimension` is used resulting in a square core.
+    base_secondary_dimension :
+        The largest dimension [m] of the rectangular base/shell component's cross-section, by default None.
+        If None and pile shape is rectangular, then the base has the same dimensions as the core.
+        Requires `height_base` to be provided.
+    base_tertiary_dimension :
+        The smallest dimension [m] of the rectangular base/shell component's cross-section, by default None.
+        If None and pile shape is rectangular, then:
+            - If `base_secondary_dimension` is None, then the base has the same dimensions as the core.
+            - If `base_secondary_dimension` is provided, then `base_tertiary_dimension` is used resulting
+            in a square base.
+        Requires `height_base` to be provided.
+    core_diameter :
+        The diameter [m] of the round core component's cross-section, by default None.
         Required for round piles.
-    base_diameter : float, optional
-        The diameter [m] of the base/shell component's cross-section, by default None.
-    pile_material : str, optional
+    base_diameter :
+        The diameter [m] of the round base/shell component's cross-section, by default None.
+        If None and pile shape is round, then the base has the same diameter as the core.
+        Requires `height_base` to be provided.
+    pile_material :
         The material of the pile, by default None.
-        Required if no standard pile type was specified.
-    custom_material : dict, optional
+        It is ignored if `custom_material` is provided.
+        Otherwise:
+            - If None, it is inferred from the standard pile.
+            - Overwrites the value of the standard pile if provided together with a standard pile.
+        Required if no standard pile type and no custom material were specified.
+    custom_material :
         A custom material for the pile, by default None.
-    settlement_curve : int, optional
+        If provided, it is used even if a standard pile was selected.
+        Required keys and value types:
+            - "name": str
+            - "elastic_modulus: float
+                Unit: [MPa]
+            - "color": str
+                Hexadecimal color
+        Example: {
+            "name": "custom_material",
+            "elastic_modulus": 15e3,
+            "color": "#ff0000",
+        }
+    settlement_curve :
         The settlement curve of the pile, by default None.
+        If None, it is inferred from the standard pile.
+        Overwrites the value of the standard pile if provided together with a standard pile.
         Required if no standard pile type was specified.
-    adhesion : float, optional
-        The adhesion of the pile, by default None.
-        Required if no standard pile type was specified.
-    alpha_p : float, optional
+    adhesion :
+        The adhesion value [kPa] of the pile, by default None.
+        Use it if the pile shaft has undergone a special treatment.
+        If None, then adhesion is disregarded.
+        Examples:
+            - adhesion = 50 kPa for synthetic coating
+            - adhesion = 20 kPa for bentonite
+            - adhesion = 10 kPa for bitumen coating
+    alpha_p :
         The alpha_p of the pile, by default None.
+        If None, it is inferred from the standard pile.
+        Overwrites the value of the standard pile if provided together with a standard pile.
         Required if no standard pile type was specified.
-    alpha_s_clay : float, optional
+    alpha_s_clay :
         The alpha_s_clay of the pile, by default None.
+        If None, it is inferred from the standard pile.
+        Overwrites the value of the standard pile if provided together with a standard pile.
         Required if no standard pile type was specified.
-    alpha_s_sand : float, optional
+    alpha_s_sand :
         The alpha_s_sand of the pile, by default None.
+        If None, it is inferred from the standard pile.
+        Overwrites the value of the standard pile if provided together with a standard pile.
         Required if no standard pile type was specified.
-    alpha_t_clay : float, optional
+    alpha_t_clay :
         The alpha_t_clay of the pile, by default None.
+        If None, it is inferred from the standard pile.
+        Overwrites the value of the standard pile if provided together with a standard pile.
         Required if no standard pile type was specified.
-    alpha_t_sand : float, optional
+    alpha_t_sand :
         The alpha_t_sand of the pile, by default None.
+        If None, it is inferred from the standard pile.
+        Overwrites the value of the standard pile if provided together with a standard pile.
         Required if no standard pile type was specified.
-    beta_p : float, optional
+    beta_p :
         The beta_p of the pile, by default None.
-        Required if no standard pile type was specified.
-    pile_tip_factor_s : float, optional
+        If None, the value is computed from the pile dimensions.
+    pile_tip_factor_s :
         The pile tip factor s of the pile, by default None.
-        Required if no standard pile type was specified.
-    is_auger : bool, optional
+        If None, the value is computed from the pile dimensions and soil properties.
+    is_auger :
         Whether the pile is an auger pile, by default None.
+        If None, it is inferred from the standard pile.
+        Overwrites the value of the standard pile if provided together with a standard pile.
         Required if no standard pile type was specified.
-    is_low_vibrating : bool, optional
+    is_low_vibrating :
         Whether the pile is low vibrating, by default None.
+        If None, it is inferred from the standard pile.
+        Overwrites the value of the standard pile if provided together with a standard pile.
         Required if no standard pile type was specified.
-    negative_fr_delta_factor : float, optional
+    negative_fr_delta_factor :
         The negative friction delta factor of the pile, by default None.
+        If None, it is inferred from the standard pile.
+        Overwrites the value of the standard pile if provided together with a standard pile.
         Required if no standard pile type was specified.
-    qc_z_a_lesser_1m : float, optional
-        Maximum cone resistance qc value allowed for layers with thickness < 1m in the calculation of positive skin friction resistance.
+    qc_z_a_lesser_1m :
+        Maximum cone resistance qc value [MPa] allowed for layers with thickness < 1m in the calculation of positive skin friction resistance.
         It must be less or equal to `qc_z_a_greater_1m`.
         If None, then 12 MPa is used.
         Default: None.
-    qc_z_a_greater_1m : float, optional
-        Maximum cone resistance qc value allowed for layers with thickness >= 1m in the calculation of positive skin friction resistance.
+    qc_z_a_greater_1m :
+        Maximum cone resistance qc value [MPa] allowed for layers with thickness >= 1m in the calculation of positive skin friction resistance.
         It must be greater or equal to `qc_z_a_lesser_1m`.
         If None, then 15 MPa is used.
         Default: None.
-    qb_max_limit : float, optional
-        Maximum value allowed for the pile tip resistance qb_max.
+    qb_max_limit :
+        Maximum value allowed for the pile tip resistance qb_max [MPa].
         Note that is value will be used as a limit for qb_max unless use_almere_rules is true and a higher value than 12 MPa is specified.
         If None, then 15 MPa is used.
         Default: None.
-    chamfered : float, optional
+    chamfered :
         The chamfered value of the pile type, by default None.
         Required if no standard pile type was specified.
 

pypilecore/input/multi_cpt.py

@@ -14,7 +14,7 @@ def create_multi_cpt_payload(
     pile_tip_levels_nap: Sequence[float],
     cptdata_objects: List[CPTData],
     classify_tables: Dict[str, dict],
-    groundwater_level_nap: float,
+    groundwater_level_nap: float | None,
     pile: PileProperties,
     friction_range_strategy: Literal[
         "manual", "lower_bound", "settlement_driven"
@@ -94,6 +94,7 @@ def create_multi_cpt_payload(
 
     groundwater_level_nap:
         The groundwater level. Unit: [m] w.r.t. NAP.
+        If None, a value of 1 meter below the ground surface level is used.
     pile:
         A PileProperties object.
     friction_range_strategy:
@@ -109,16 +110,21 @@ def create_multi_cpt_payload(
         objects in `cptdata_objects`.
     ocr:
         The Over-Consolidation-Ratio [-] of the foundation layer.
+        It applies to all CPTs, unless overruled for specific CPTs in `individual_ocr`.
+        If None, an OCR of 1.0 is assumed.
+        Default = None
     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
-        and bottom where top and bottom are floating values.
+        is calculated. It applies to all CPTs, unless overruled for specific CPTs in
+        `individual_negative_friction_range_nap`. If an array of format [top, bottom],
+        the range is set between top and bottom where top and bottom are floating values.
         Unit: [m] w.r.t. NAP
     fixed_positive_friction_range_nap:
         Optionally sets the fixed depth range between which the positive sleeve friction
-        is calculated. If an array of format (top, bottom), the range is set between top
-        and bottom where top and bottom are floating point values. If bottom == "ptl",
-        the pile tip level of the calculation is used as value for bottom.
+        is calculated. It applies to all CPTs, unless overruled for specific CPTs in
+        `individual_positive_friction_range_nap`. If an array of format (top, bottom),
+        the range is set between top and bottom where top and bottom are floating point values.
+        If bottom == "ptl", the pile tip level of the calculation is used as value for bottom.
         Unit: [m] w.r.t. NAP
     negative_shaft_friction:
         Sets a fixed value for the negative friction force. If provided, the
@@ -142,20 +148,22 @@ def create_multi_cpt_payload(
         Default = 0.7
     pile_load_sls:
         Force on pile in SLS [kN]. Used to determine settlement of pile w.r.t. soil.
+        if None, the fraction of the bearing capacity provided in `relative_pile_load` is used.
+        Default = None
     soil_load_sls:
         Load on soil surface [kPa], used to calculate soil settlement. This is only required
         with the settlement-driven friction-range strategy.
         Default = 0.0
     pile_head_level_nap:
         The level of the pile head. Can be:
-
-            - float;
-                This is interpreted as an absolute level in [m w.r.t. NAP];
+            - float:
+                This is interpreted as an absolute level in [m w.r.t. NAP].
             - Literal["surface"] (default).
-                In this case, the soil_properties.service_level
-                property is used.
+                In this case, the soil_properties.service_level property is used.
     excavation_depth_nap:
         Soil excavation depth after the CPT was taken. Unit: [m] w.r.t. NAP.
+        If None, a value equal to the ground surface level is used.
+        Default = None
     excavation_param_t:
         Excavation parameter depending on pile installation method and/or phasing.
             - Use 1.0 (default) for post-excavation installation with vibration (i.e. hammering).
@@ -185,15 +193,20 @@ def create_multi_cpt_payload(
             - 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``
+        A dictionary, mapping specific CPTs (using the ``CPTData.alias`` as keys) to fixed negative-friction ranges (as values).
+        For a specification of the values, see ``fixed_negative_friction_range_nap``.
+        This will overrule the general `fixed_negative_friction_range_nap` setting for the given CPTs only.
+        Example: {"S03": (-5.5, -17.5)}
     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``
+        A dictionary, mapping specific CPTs (using the ``CPTData.alias`` as keys) to fixed positive-friction ranges (as values).
+        For a specification of the values, see ``fixed_positive_friction_range_nap``.
+        This will overrule the general `fixed_positive_friction_range_nap` setting for the given CPTs only.
+        Example: {"S03": (-17.5, 'ptl')}
     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
+        A dictionary, mapping specific CPTs (using the `CPTData.alias`` as keys) to Over-Consolidation-Ratio [-]
+        of the foundation layer (as values). This will overrule the general `ocr` setting for
         these specific CPTs only.
+        Example: {"S03": 1.5}
     use_almere_rules:
         If set to True the contribution, produced by the positive shaft friction, to the
         total bearing capacity is limited to at most 75% the contribution provided by

pypilecore/input/soil_properties.py

@@ -41,7 +41,7 @@ def get_cpt_depth(cpt: CPTData) -> NDArray:
 def create_soil_properties_payload(
     cptdata_objects: List[CPTData],
     classify_tables: Dict[str, dict],
-    groundwater_level_nap: float,
+    groundwater_level_nap: float | None,
     friction_range_strategy: Literal["manual", "lower_bound", "settlement_driven"],
     excavation_depth_nap: float | None = None,
     master_ocr: float | None = None,
@@ -95,6 +95,7 @@ def create_soil_properties_payload(
                 undrained shear strength [kPa]
     groundwater_level_nap:
         The groundwater level. Unit: [m] w.r.t. NAP.
+        If None, a value of 1 meter below the ground surface level is used.
     friction_range_strategy:
         Sets the method to determine the sleeve friction zones on the pile. The soil
         friction in the positive zone contributes to the bearing capacity, while the
@@ -102,6 +103,8 @@ 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.
+        If None, a value equal to the ground surface level is used.
+        Default = None
     ocr:
         The Over-Consolidation-Ratio [-] of the foundation layer.
     individual_negative_friction_range_nap: