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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-pilecore
-Version: 0.3.4
+Version: 0.4.1
 Summary: Public python SDK for the CEMS PileCore web-API.
 License: MIT License
         
@@ -37,6 +37,7 @@ 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
 Provides-Extra: docs
 Requires-Dist: Sphinx ==6.1.3 ; extra == 'docs'
 Requires-Dist: sphinx-autodoc-typehints ==1.22 ; extra == 'docs'

py_pilecore-0.4.1.dist-info/RECORD

@@ -0,0 +1,24 @@
+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,,

{py_pilecore-0.3.4.dist-info → py_pilecore-0.4.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.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.3.4"
+    __version__ = "0.4.1"

pypilecore/api.py

@@ -5,29 +5,67 @@ from nuclei.client import NucleiClient
 from requests import Response
 
 
-def wait_until_ticket_is_ready(client: NucleiClient, ticket: Response) -> None:
+def wait_until_ticket_is_ready(
+    client: NucleiClient, ticket: Response, verbose: bool = False
+) -> None:
+    if verbose:
+        logging.info("Waiting for ticket to be ready")
+
     if ticket.status_code != 200:
         raise RuntimeError(rf"{ticket.text}")
 
+    if verbose:
+        logging.info("Ticket status: OK")
+        logging.info(f"Ticket ID: {ticket.json()['id']}")
+
     status = "STARTED"
     sleep_time = 0.05
+
     while status in ["PENDING", "STARTED", "RETRY"]:
+        # Exponential backoff
         sleep_time = min(sleep_time * 2, 10)
+        if verbose:
+            logging.info("Sleeping for %s seconds", sleep_time)
         sleep(sleep_time)
-        response = client.call_endpoint(
+
+        # Get the status of the ticket
+        if verbose:
+            logging.info("Polling ticket status")
+        status_response = client.call_endpoint(
             "PileCore", "/get-task-status", schema=ticket.json(), return_response=True
         )
-        if response.status_code != 200:
-            raise RuntimeError(rf"{response.text}")
-        status = response.json()["state"]
 
-    if status == "FAILURE":
-        raise RuntimeError(
-            f'Status: {response.json()["msg"]}. {response.json()["msg"]}'
-        )
+        # Check if the status response is OK
+        if status_response.status_code != 200:
+            raise RuntimeError(rf"{status_response.text}")
 
+        status = status_response.json()["state"]
+        if verbose:
+            logging.info("Ticket status: %s", status)
 
-def get_multi_cpt_api_result(client: NucleiClient, payload: dict) -> dict:
+    # If the status is FAILURE, raise an error
+    if status == "FAILURE":
+        # Get the task-status failure message
+        failure_message = status_response.json()["msg"]
+
+        # Try to get the task-result failure message
+        try:
+            result_response = client.call_endpoint(
+                "PileCore",
+                "/get-task-result",
+                schema=ticket.json(),
+                return_response=True,
+            )
+            failure_message = result_response.text
+
+        # Raise the obtained failure message
+        finally:
+            raise RuntimeError(failure_message)
+
+
+def get_multi_cpt_api_result(
+    client: NucleiClient, payload: dict, verbose: bool = False
+) -> dict:
     """
     Wrapper around the PileCore endpoint "/compression/multiple-cpts/results".
 
@@ -37,6 +75,8 @@ def get_multi_cpt_api_result(client: NucleiClient, payload: dict) -> dict:
         client object created by [nuclei](https://github.com/cemsbv/nuclei)
     payload: dict
         the payload of the request, can be created by calling `create_grouper_payload()`
+    verbose: bool
+        if True, print additional information to the console
     """
     logging.info(
         "Calculating bearing capacities... \n"
@@ -49,12 +89,14 @@ def get_multi_cpt_api_result(client: NucleiClient, payload: dict) -> dict:
         return_response=True,
     )
 
-    wait_until_ticket_is_ready(client=client, ticket=ticket)
+    wait_until_ticket_is_ready(client=client, ticket=ticket, verbose=verbose)
 
     return client.call_endpoint("PileCore", "/get-task-result", schema=ticket.json())
 
 
-def get_multi_cpt_api_report(client: NucleiClient, payload: dict) -> dict:
+def get_multi_cpt_api_report(
+    client: NucleiClient, payload: dict, verbose: bool = False
+) -> dict:
     """
     Wrapper around the PileCore endpoint "/compression/multiple-cpts/report".
 
@@ -64,6 +106,8 @@ def get_multi_cpt_api_report(client: NucleiClient, payload: dict) -> dict:
         client object created by [nuclei](https://github.com/cemsbv/nuclei)
     payload: dict
         the payload of the request, can be created by calling `create_grouper_payload()`
+    verbose: bool
+        if True, print additional information to the console
     """
     logging.info(
         "Generate report... \n"
@@ -75,12 +119,14 @@ def get_multi_cpt_api_report(client: NucleiClient, payload: dict) -> dict:
         schema=payload,
         return_response=True,
     )
-    wait_until_ticket_is_ready(client=client, ticket=ticket)
+    wait_until_ticket_is_ready(client=client, ticket=ticket, verbose=verbose)
 
     return client.call_endpoint("PileCore", "/get-task-result", schema=ticket.json())
 
 
-def get_groups_api_result(client: NucleiClient, payload: dict) -> dict:
+def get_groups_api_result(
+    client: NucleiClient, payload: dict, verbose: bool = False
+) -> dict:
     """
     Wrapper around the PileCore endpoint "/grouper/group_cpts".
 
@@ -90,6 +136,8 @@ def get_groups_api_result(client: NucleiClient, payload: dict) -> dict:
         client object created by [nuclei](https://github.com/cemsbv/nuclei)
     payload: dict
         the payload of the request, can be created by calling `create_grouper_payload()`
+    verbose: bool
+        if True, print additional information to the console
     """
     logging.info(
         "Finding groups... \n"
@@ -102,12 +150,14 @@ def get_groups_api_result(client: NucleiClient, payload: dict) -> dict:
         return_response=True,
     )
 
-    wait_until_ticket_is_ready(client=client, ticket=ticket)
+    wait_until_ticket_is_ready(client=client, ticket=ticket, verbose=verbose)
 
     return client.call_endpoint("PileCore", "/get-task-result", schema=ticket.json())
 
 
-def get_optimize_groups_api_result(client: NucleiClient, payload: dict) -> dict:
+def get_optimize_groups_api_result(
+    client: NucleiClient, payload: dict, verbose: bool = False
+) -> dict:
     """
     Wrapper around the PileCore endpoint "/grouper/optimize_groups".
 
@@ -117,6 +167,8 @@ def get_optimize_groups_api_result(client: NucleiClient, payload: dict) -> dict:
         client object created by [nuclei](https://github.com/cemsbv/nuclei)
     payload: dict
         the payload of the request, can be created by calling `create_grouper_payload()`
+    verbose: bool
+        if True, print additional information to the console
     """
     logging.info(
         "Optimize groups... \n"
@@ -129,12 +181,14 @@ def get_optimize_groups_api_result(client: NucleiClient, payload: dict) -> dict:
         return_response=True,
     )
 
-    wait_until_ticket_is_ready(client=client, ticket=ticket)
+    wait_until_ticket_is_ready(client=client, ticket=ticket, verbose=verbose)
 
     return client.call_endpoint("PileCore", "/get-task-result", schema=ticket.json())
 
 
-def get_groups_api_report(client: NucleiClient, payload: dict) -> bytes:
+def get_groups_api_report(
+    client: NucleiClient, payload: dict, verbose: bool = False
+) -> bytes:
     """
     Wrapper around the PileCore endpoint "/grouper/generate_grouper_report".
 
@@ -144,6 +198,8 @@ def get_groups_api_report(client: NucleiClient, payload: dict) -> bytes:
         client object created by [nuclei](https://github.com/cemsbv/nuclei)
     payload: dict
         the payload of the request, can be created by calling `create_grouper_report_payload()`
+    verbose: bool
+        if True, print additional information to the console
     """
     logging.info(
         "Generate report... \n"
@@ -156,6 +212,6 @@ def get_groups_api_report(client: NucleiClient, payload: dict) -> bytes:
         return_response=True,
     )
 
-    wait_until_ticket_is_ready(client=client, ticket=ticket)
+    wait_until_ticket_is_ready(client=client, ticket=ticket, verbose=verbose)
 
     return client.call_endpoint("PileCore", "/get-task-result", schema=ticket.json())

pypilecore/input/grouper_properties.py

@@ -43,7 +43,7 @@ def create_grouper_payload(
     "/grouper/group_cpts"
 
 
-    Notes
+    Note
     ------
     The grouper uses pile bearing capacity results calculated by PileCore or other software to
     form  subgroups of the total group of CPT’s belonging to this project.
@@ -56,7 +56,6 @@ def create_grouper_payload(
         - is spatially coherent, which means there are no other CPTs in between the members
           of the subgroup. (Spatial check)
 
-
     Additionally, centre to centre validation (include_centre_to_centre_check; NEN9997-1 3.2.3) can be
     added to the cluster method. This check adds restrictions to the maximum allowable R;c;cal outliers
     and makes sure that the suitable data density requirements for the subgroup are met, by checking the

pypilecore/input/multi_cpt.py

@@ -344,7 +344,7 @@ def create_multi_cpt_payload(
         pile_head_level_nap=pile_head_level_nap,
         stiff_construction=stiff_construction,
         rel_pile_load=relative_pile_load,
-        soil_load=soil_load_sls,
+        soil_load=soil_load_sls if soil_load_sls is not None else 0.0,
         excavation_param_t=excavation_param_t,
         use_almere_rules=use_almere_rules,
         gamma_f_nk=gamma_f_nk,

pypilecore/input/pile_properties.py

@@ -29,8 +29,9 @@ def create_pile_properties_payload(
     Creates a dictionary with the `pile_properties` payload content for the PileCore
     endpoints.
 
-    Note that
-    the dictionary should be converted to a jsonifyable message before it can be passed
+    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()`.
 

pypilecore/input/soil_properties.py

@@ -35,7 +35,7 @@ def create_soil_properties_payload(
     Creates a dictionary with the `soil_properties` payload content for the PileCore
     endpoints.
 
-    Notes
+    Note
     ------
     the dictionary should be converted to a jsonifyable message before it can be passed
     to a `requests` call directly, for instance with
@@ -149,7 +149,7 @@ def create_soil_properties_payload(
             else cpt.delivered_vertical_position_offset - 1,
             coordinates=dict(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