Add Weight Sounding Test (WST) (#11)

* Dissipation test  HM = 35 addition

* Dissipation test  HM = 35 addition 2

* Dissipation test  HM = 35 addition 3

* Dissipation test  HM = 35 addition 4

* Work in progress. Checking in for backup.
Start on WST

* Add missing import
Bump version to 0.0.1a3

* Extend MethodWST
Ran ruff formatting
Fix wrong default type for predrilling_depth (int -> Decimal)
Add test

* Update the lock file

* Update the lock file.
Add The Unlicense license to accepted ones.

---------

Co-authored-by: Camelia Dominguez Quintans <camelia.dominguez.quintans@ngi.no>

Author: josteinl

.github/workflows/branch.yaml

@@ -51,6 +51,6 @@ jobs:
       - name: Run bandit
         run: poetry run bandit .
       - name: Run safety
-        run: poetry run safety check -i 62044 -i 70612
+        run: poetry run safety check -i 70612
       - name: Check for acceptable licenses
-        run: poetry run pip-licenses --allow-only="MIT License;BSD License;Python Software Foundation License;Apache Software License;Mozilla Public License 2.0 (MPL 2.0);ISC License (ISCL)"
+        run: poetry run pip-licenses --allow-only="MIT License;BSD License;Python Software Foundation License;Apache Software License;Mozilla Public License 2.0 (MPL 2.0);ISC License (ISCL);The Unlicense (Unlicense)"

CHANGES.md

@@ -1,11 +1,18 @@
 # NGI Python SGF Parser Package
 
+_2024-07-29_
+
+Version 0.0.1b2
+
+Support Weight Sounding Test (WST) (Swedish Viktsondering)
+
 _2024-06-21_
 
 Version 0.0.1b1
 
 Update packages.
 
+
 _2024-05-22_
 
 Version 0.0.1a2

poetry.lock

@@ -15,7 +15,7 @@ exclude = '''
 
 [tool.poetry]
 name = "sgf-parser"
-version = "0.0.1b1"
+version = "0.0.1b2"
 description = "Parser for the Swedish Geotechnical Society / Svenska Geotekniska Föreningen (SGF) data format"
 license = "MIT"
 authors = ["Jostein Leira <jostein@leira.net>"]
@@ -58,7 +58,7 @@ no_implicit_reexport = false
 
 [tool.poetry.dependencies]
 python = ">=3.11,<4"
-pydantic = "^2.6.3"
+pydantic = "^2.7.1"
 python-dateutil = "^2.9.0.post0"
 types-python-dateutil = "^2.8.19.20240311"
 
@@ -71,6 +71,8 @@ bandit = "*"
 safety = "*"
 pip-licenses = "*"
 ruff = "*"
+# Pinned due to problem with unpinned ruamel-yaml subdependency ruamel-yaml-clib not able to install on windows
+ruamel-yaml-clib={platform = "win32", version = "<0.2.6"}
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

pyproject.toml

@@ -1 +1 @@
-from sgf_parser.parser import Parser
+from sgf_parser.parser import Parser

src/sgf_parser/__init__.py

@@ -8,3 +8,4 @@
 from sgf_parser.models.method_srs import MethodSRS, MethodSRSData
 from sgf_parser.models.method_svt import MethodSVT, MethodSVTData
 from sgf_parser.models.method_tot import MethodTOT, MethodTOTData
+from sgf_parser.models.method_wst import MethodWST, MethodWSTData

src/sgf_parser/models/__init__.py

@@ -355,7 +355,7 @@ def guess_date_format(cls, data: Any) -> Any:
     serial_number: str | None = Field(None, alias="HC")
 
     # "HO": "predrilling_depth",
-    predrilling_depth: Decimal = Field(0, alias="HO")
+    predrilling_depth: Decimal = Field(Decimal("0"), alias="HO")
 
     # "HQ": "conducted_by",
     conducted_by: str | None = Field(None, alias="HQ")

src/sgf_parser/models/method.py

@@ -1,7 +1,7 @@
 from decimal import Decimal
 from typing import Literal
 
-from pydantic import Field
+from pydantic import Field, computed_field
 
 from sgf_parser.models import MethodType, MethodData, Method
 
@@ -18,6 +18,7 @@ def __init__(self, **kwargs):
     u2: Decimal | None = Field(None, alias="AG", description="Shoulder pressure (kPa)")
     depth: Decimal | None = Field(None, alias="D", description="Depth (m)")
 
+
 class MethodDT(Method):
     """
     Method Pore Pressure Dissipation Test (placeholder)
@@ -30,4 +31,20 @@ def __init__(self, **kwargs):
     method_type: Literal[MethodType.DT] = MethodType.DT
     method_data_type: type[MethodDTData] = MethodDTData
 
-    method_data: list[MethodDTData] = []
+    method_data: list[MethodDTData] = []
+
+    @computed_field
+    def stopcode(self) -> int | None:
+        if not self.method_data:
+            return None
+
+        return self.method_data[-1].comment_code
+
+    def post_processing(self):
+        """
+        Post-processing
+
+        """
+
+        if not self.method_data:
+            return

src/sgf_parser/models/method_dt.py

@@ -0,0 +1,67 @@
+from decimal import Decimal
+from typing import Literal, Any
+
+from pydantic import Field, model_validator, computed_field
+
+from sgf_parser.models import MethodData, Method, MethodType
+from sgf_parser.models.types import Operation
+
+
+class MethodWSTData(MethodData):
+    """
+    Weight Sounding Test (Swedish Viktsondering) Data
+    """
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+    depth: Decimal = Field(..., alias="D", description="Depth (m)")
+    turning: Decimal = Field(..., alias="H", description="Turning (half revolution/0.2 m)")
+    load: Decimal = Field(..., alias="W", description="Load (kN)")
+    penetration_rate: Decimal | None = Field(None, alias="B", description="Penetration rate (mm/s)")
+
+    hammering: bool | None = Field(None, alias="AP")
+    rotation_rate: Decimal | None = Field(None, alias="R", description="Rotation rate (rpm)")
+
+
+class MethodWST(Method):
+    """
+    Weight Sounding Test (Swedish Viktsondering)
+    """
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+    name: str = "WST"
+    method_type: Literal[MethodType.WST] = MethodType.WST
+    method_data_type: type[MethodWSTData] = MethodWSTData
+
+    operation: Operation = Operation.MECHANICAL
+
+    method_data: list[MethodWSTData] = []
+
+    @computed_field
+    def depth_top(self) -> Decimal | None:
+        if not self.method_data:
+            return None
+
+        return min(method_data.depth for method_data in self.method_data)
+
+    @computed_field
+    def depth_base(self) -> Decimal | None:
+        if not self.method_data:
+            return None
+
+        return max(method_data.depth for method_data in self.method_data)
+
+    @model_validator(mode="before")
+    @classmethod
+    def set_operation(cls, data: Any) -> Any:
+        if isinstance(data, dict):
+            if "HM" in data and data["HM"] is not None:
+                data["operation"] = {
+                    "101": Operation.MANUAL,
+                    "102": Operation.MECHANICAL,
+                }[data["HM"]]
+
+        return data

src/sgf_parser/models/method_wst.py

@@ -125,3 +125,12 @@ class SoundingClass(enum.StrEnum):
     JB2 = "Jb-2"
     JB3 = "Jb-3"
     JBTOT = "Jb-tot"
+
+
+class Operation(enum.StrEnum):
+    """
+    Operation
+    """
+
+    MANUAL = "MANUAL"
+    MECHANICAL = "MECHANICAL"