py-pilecore 0.8.0__py3-none-any.whl → 0.8.2__py3-none-any.whl

{py_pilecore-0.8.0.dist-info → py_pilecore-0.8.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py-pilecore
-Version: 0.8.0
+Version: 0.8.2
 Summary: Public python SDK for the CEMS PileCore web-API.
 License: MIT License
         
@@ -29,39 +29,39 @@ Keywords: API,PileCore,CEMS,CRUX
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pygef <1,>0.8
-Requires-Dist: numpy <2,>1
-Requires-Dist: pandas <3,>2
-Requires-Dist: cems-nuclei[client] <2,>=1
-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.13
-Requires-Dist: ipywidgets <9,>=8
-Requires-Dist: dash <3,>=2.17
-Requires-Dist: plotly-geo <2,>=1.0.0
+Requires-Dist: pygef<1,>0.8
+Requires-Dist: numpy<2,>1
+Requires-Dist: pandas<3,>2
+Requires-Dist: cems-nuclei[client]<2,>=1
+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.13
+Requires-Dist: ipywidgets<9,>=8
+Requires-Dist: dash<3,>=2.17
+Requires-Dist: plotly-geo<2,>=1.0.0
+Provides-Extra: test
+Requires-Dist: coveralls; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: openapi-core; extra == "test"
 Provides-Extra: docs
-Requires-Dist: Sphinx ==6.1.3 ; extra == 'docs'
-Requires-Dist: sphinx-autodoc-typehints ==1.22 ; extra == 'docs'
-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'
+Requires-Dist: Sphinx==6.1.3; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints==1.22; extra == "docs"
+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: 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: 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'
+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: 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"
 
 # py-pilecore
 Public python SDK for the CEMS PileCore web-API
@@ -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.dist-info → py_pilecore-0.8.2.dist-info}/RECORD

@@ -1,12 +1,12 @@
 pypilecore/__init__.py,sha256=oJvwYShj_7FyNVlUgQda4tTdYyLIi5H1asdiS_uYt9M,162
-pypilecore/_version.py,sha256=OzojhIrdvY9MCKmMOhNF-cqJ88tpWGVtDAkfU9UKSuA,175
+pypilecore/_version.py,sha256=FyPanIUkBPhYghbhEw_aK3Ld2xsxcNUrJnwhCmvpgUk,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
 pypilecore/utils.py,sha256=ib9LgJBIgWukL7zd_Zk1LP27UTMIZTRJ4RBB6ubn97o,1186
 pypilecore/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pypilecore/common/piles/__init__.py,sha256=xHP56HiBc1sHg2WZ9iG6CSJAgR072ZwD83lp8PSdTa4,114
-pypilecore/common/piles/main.py,sha256=9Yy1VTD6p80Y33ycEFjafVbjgwjmdObMWetejocxI_0,10519
+pypilecore/common/piles/main.py,sha256=CKhPxWrI0KGhAPSBZRcaSR0stF5x65e7JIynJK3l5Mk,10583
 pypilecore/common/piles/type.py,sha256=rxaJZ2MAybLdoGqb1KEBh8KYpaKEwnoebEq2bjBrahk,7227
 pypilecore/common/piles/geometry/__init__.py,sha256=dFCVazEXnPCt5cQeHkSi5wp-yHRB9gKvtlQ3V5kBuOQ,438
 pypilecore/common/piles/geometry/main.py,sha256=ant3y1ZTGRN2off5-dwz2024Xa7pC0K7auBbmjTy9p8,11231
@@ -18,7 +18,7 @@ pypilecore/common/piles/geometry/components/round.py,sha256=MX2_qGmxr1dTtodblFfk
 pypilecore/input/__init__.py,sha256=Gyqsp6zqc8AYnIp17SfqbBNjDaUkRgAam8x2r0XibwM,492
 pypilecore/input/grouper_properties.py,sha256=4Rhea8pnrbWqIIiplHdPS-EioDRurCcLe6thHkGkBEM,11146
 pypilecore/input/multi_cpt.py,sha256=b5poixEs5ex8WGcu3rJiFMdS5Q4DE807L6jmeqiFE64,17506
-pypilecore/input/soil_properties.py,sha256=ms2zxRPK_0zJAgei4QTJhC71Y7ivUguqoRTDUzuqyl8,8277
+pypilecore/input/soil_properties.py,sha256=fsgkdvLsNf7LqiQh-gIDS9XSZBO7BJJ_qp6bIs8TLz0,9061
 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
@@ -37,8 +37,8 @@ pypilecore/viewers/interactive_figures/figure_cpt_group_results_versus_ptls.py,s
 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=B2X8hbbmJqjm8E2VrS2EoX5F1yQ5qOQnQUG_vbsseT8,1692
-py_pilecore-0.8.0.dist-info/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
-py_pilecore-0.8.0.dist-info/METADATA,sha256=BG2GoeElfIi1iPSPaWKKQmEoBesJORCttvMW1DzqzGA,5653
-py_pilecore-0.8.0.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-py_pilecore-0.8.0.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
-py_pilecore-0.8.0.dist-info/RECORD,,
+py_pilecore-0.8.2.dist-info/LICENSE,sha256=3OCAZXffN0Bettjeya8uF_ZYegyvvCfH1WUt6CrHb_0,1061
+py_pilecore-0.8.2.dist-info/METADATA,sha256=eIyZk-NDIkafvDb49nBebn4tlwDvBmnaKPPhqWh-C3c,5831
+py_pilecore-0.8.2.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+py_pilecore-0.8.2.dist-info/top_level.txt,sha256=7BKIWZuSkbQtJ0ho5P1JvcaEbHzqADCcBuOduZmIaiI,11
+py_pilecore-0.8.2.dist-info/RECORD,,

{py_pilecore-0.8.0.dist-info → py_pilecore-0.8.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: setuptools (75.6.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.8.0"
+    __version__ = "0.8.2"

pypilecore/common/piles/main.py

@@ -68,7 +68,9 @@ class PileProperties:
     @property
     def name(self) -> str | None:
         """The name of the pile."""
-        return self._name
+        if self._name is not None:
+            return str(self._name)
+        return None
 
     def serialize_payload(self) -> Dict[str, dict | str]:
         """

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),
         )