py-pilecore 0.8.0__tar.gz → 0.8.1__tar.gz

{py_pilecore-0.8.0/src/py_pilecore.egg-info → py_pilecore-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-pilecore
-Version: 0.8.0
+Version: 0.8.1
 Summary: Public python SDK for the CEMS PileCore web-API.
 License: MIT License
         
@@ -168,3 +168,9 @@ Update the requirements within the defined ranges with:
 ```bash
 pip-compile --upgrade --extra=test --extra=lint --extra=docs --output-file=requirements.txt pyproject.toml
 ```
+
+Note that `pip-compile` might run from your global path. You can also invoke the compile
+command from the `piptools` module on a specific python installation (e.g. within a virtualenv):
+
+```bash
+python -m piptools compile

{py_pilecore-0.8.0 → py_pilecore-0.8.1}/README.md

@@ -102,4 +102,10 @@ Update the requirements within the defined ranges with:
 
 ```bash
 pip-compile --upgrade --extra=test --extra=lint --extra=docs --output-file=requirements.txt pyproject.toml
-```
+```
+
+Note that `pip-compile` might run from your global path. You can also invoke the compile
+command from the `piptools` module on a specific python installation (e.g. within a virtualenv):
+
+```bash
+python -m piptools compile

{py_pilecore-0.8.0 → py_pilecore-0.8.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "py-pilecore"
-version = "0.8.0"
+version = "0.8.1"
 description = "Public python SDK for the CEMS PileCore web-API."
 requires-python = ">=3.9"
 dependencies = [

{py_pilecore-0.8.0 → py_pilecore-0.8.1/src/py_pilecore.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-pilecore
-Version: 0.8.0
+Version: 0.8.1
 Summary: Public python SDK for the CEMS PileCore web-API.
 License: MIT License
         
@@ -168,3 +168,9 @@ Update the requirements within the defined ranges with:
 ```bash
 pip-compile --upgrade --extra=test --extra=lint --extra=docs --output-file=requirements.txt pyproject.toml
 ```
+
+Note that `pip-compile` might run from your global path. You can also invoke the compile
+command from the `piptools` module on a specific python installation (e.g. within a virtualenv):
+
+```bash
+python -m piptools compile

{py_pilecore-0.8.0 → py_pilecore-0.8.1}/src/pypilecore/_version.py

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

{py_pilecore-0.8.0 → py_pilecore-0.8.1}/src/pypilecore/input/soil_properties.py

@@ -1,8 +1,10 @@
 from __future__ import annotations
 
+import warnings
 from typing import Any, Dict, List, Literal, Mapping, Tuple
 
 import numpy as np
+from numpy.typing import NDArray
 from pygef.cpt import CPTData
 from tqdm import tqdm
 
@@ -16,6 +18,26 @@ transform = {
 }
 
 
+def get_cpt_depth(cpt: CPTData) -> NDArray:
+    """
+    Returns the array of depth data from the CPT. Uses the (corrected) depth data if
+    present, otherwise the `penetrationLength` data along with a warning.
+    """
+    if "depth" in cpt.data.columns:
+        depth = cpt.data["depth"]
+    elif "penetrationLength" in cpt.data.columns:
+        warnings.warn(
+            f"CPT {cpt.alias} has no Corrected Depth trace. py-pilecore uses the Penetration Length instead, which might not be accurate."
+        )
+        depth = cpt.data["penetrationLength"]
+    else:
+        raise ValueError(
+            f"Cannot process CPT {cpt.alias}: required Corrected Depth or Penetration Length data is missing."
+        )
+
+    return np.array(depth, dtype=float)
+
+
 def create_soil_properties_payload(
     cptdata_objects: List[CPTData],
     classify_tables: Dict[str, dict],
@@ -117,7 +139,7 @@ def create_soil_properties_payload(
 
         # Construct the cpt_data payload
         cpt_data = dict(
-            depth=np.array(cpt.data["depth"], dtype=float),
+            depth=get_cpt_depth(cpt),
             qc=np.array(cpt.data["coneResistance"], dtype=float).clip(0),
         )