compass-lib 0.0.3__tar.gz → 0.0.4__tar.gz

{compass_lib-0.0.3 → compass_lib-0.0.4}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: compass_lib
-Version: 0.0.3
+Version: 0.0.4
 Summary: Compass Parser Library.
 Keywords: cave,survey,karst
 Author-email: Jonathan Dekhtiar <jonathan@dekhtiar.com>
 Maintainer-email: Jonathan Dekhtiar <jonathan@dekhtiar.com>
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -21,11 +21,14 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 License-File: LICENSE
 Requires-Dist: geojson>=3.2,<4
+Requires-Dist: numpy>=1.26,<3
+Requires-Dist: scipy>=1.12,<2
 Requires-Dist: orjson>=3.10,<3.12
 Requires-Dist: pydantic>=2.12,<2.13
 Requires-Dist: pydantic-extra-types>=2.11,<3.0
 Requires-Dist: pyIGRF14==1.0.4
 Requires-Dist: pyproj>=3.7.1,<3.8
+Requires-Dist: shapely>=2.0,<3
 Requires-Dist: utm>=0.8.1,<0.9
 Requires-Dist: cryptography>=44.0.0,<47.0.0 ; extra == "test"
 Requires-Dist: python-dotenv>=1.0.0,<2.0.0 ; extra == "test"

{compass_lib-0.0.3 → compass_lib-0.0.4}/compass_lib/__init__.py

@@ -12,16 +12,16 @@ Usage:
     for file_dir in project.file_directives:
         print(f"File: {file_dir.file}")
         if file_dir.data:
-            for trip in file_dir.data.trips:
-                print(f"  Survey: {trip.header.survey_name}")
+            for survey in file_dir.data.surveys:
+                print(f"  Survey: {survey.header.survey_name}")
 
     # Or load individual files
     from compass_lib import read_dat_file, read_mak_file
-    trips = read_dat_file(Path("survey.DAT"))
+    surveys = read_dat_file(Path("survey.DAT"))
     directives = read_mak_file(Path("project.MAK"))
 """
 
-__version__ = "0.0.3"
+__version__ = "0.0.4"
 
 # Constants
 from compass_lib.constants import COMPASS_ENCODING
@@ -60,8 +60,8 @@ from compass_lib.project.models import FileDirective
 from compass_lib.project.models import LinkStation
 from compass_lib.survey.models import CompassDatFile
 from compass_lib.survey.models import CompassShot
-from compass_lib.survey.models import CompassTrip
-from compass_lib.survey.models import CompassTripHeader
+from compass_lib.survey.models import CompassSurvey
+from compass_lib.survey.models import CompassSurveyHeader
 from compass_lib.validation import days_in_month
 from compass_lib.validation import is_valid_station_name
 from compass_lib.validation import validate_station_name
@@ -88,8 +88,8 @@ __all__ = [
     "CompassParseError",
     "CompassParseException",
     "CompassShot",
-    "CompassTrip",
-    "CompassTripHeader",
+    "CompassSurvey",
+    "CompassSurveyHeader",
     "DrawOperation",
     "FileDirective",
     "FileFormat",

{compass_lib-0.0.3 → compass_lib-0.0.4}/compass_lib/commands/convert.py

@@ -120,13 +120,15 @@ def _convert(
     if source_format == FileFormat.COMPASS and target_format == FileFormat.JSON:
         # Compass -> JSON using Pydantic
         if file_type == CompassFileType.DAT:
-            trips = read_dat_file(input_path)
-            dat_file = CompassDatFile(trips=trips)
+            surveys = read_dat_file(input_path)
+            dat_file = CompassDatFile(surveys=surveys)
             # Wrap in format envelope for DAT files
             envelope = {
                 "version": "1.0",
                 "format": FormatIdentifier.COMPASS_DAT.value,
-                "trips": json.loads(dat_file.model_dump_json(by_alias=True))["trips"],
+                "surveys": json.loads(dat_file.model_dump_json(by_alias=True))[
+                    "surveys"
+                ],
             }
             result = json.dumps(envelope, indent=2, sort_keys=True)
         else:  # mak
@@ -139,9 +141,9 @@ def _convert(
         if file_type == CompassFileType.DAT:
             data = json.loads(json_str)
             # Handle both envelope format and raw format
-            trips_data = data.get("trips", [])
-            dat_file = CompassDatFile.model_validate({"trips": trips_data})
-            result = format_dat_file(dat_file.trips) or ""
+            surveys_data = data.get("surveys", [])
+            dat_file = CompassDatFile.model_validate({"surveys": surveys_data})
+            result = format_dat_file(dat_file.surveys) or ""
         else:  # mak
             project = CompassMakFile.model_validate_json(json_str)
             result = format_mak_file(project.directives) or ""

{compass_lib-0.0.3 → compass_lib-0.0.4}/compass_lib/commands/geojson.py

@@ -11,6 +11,10 @@ from pathlib import Path
 
 from compass_lib.enums import FileExtension
 from compass_lib.geojson import convert_mak_to_geojson
+from compass_lib.solver.ariane import ArianeSolver
+from compass_lib.solver.lse import LSESolver
+from compass_lib.solver.proportional import ProportionalSolver
+from compass_lib.solver.sparse import SparseSolver
 
 logger = logging.getLogger(__name__)
 
@@ -74,6 +78,32 @@ Notes:
         action="store_true",
         help="Include passage polygon features (from LRUD data)",
     )
+    parser.add_argument(
+        "--anchors",
+        action="store_true",
+        help="Include anchor point features (fixed reference stations)",
+    )
+    parser.add_argument(
+        "--no-colors",
+        action="store_true",
+        help="Disable origin-based coloring of stations and legs",
+    )
+    parser.add_argument(
+        "--solver",
+        choices=["proportional", "sparse", "lse", "ariane", "none"],
+        default="proportional",
+        help="Survey adjustment solver: "
+        "proportional (L2, spreads error evenly), "
+        "sparse (L1, fewest/smallest changes), "
+        "lse (blunder-aware, protects good data), "
+        "ariane (sparse CG + blunder-aware, scales to large caves), "
+        "none (raw BFS, shows misclosure gaps)",
+    )
+    parser.add_argument(
+        "--minify",
+        action="store_true",
+        help="Compact output without indentation (smaller file size)",
+    )
 
     parsed_args = parser.parse_args(args)
 
@@ -89,12 +119,25 @@ Notes:
         return 1
 
     try:
+        solvers = {
+            "proportional": ProportionalSolver,
+            "sparse": SparseSolver,
+            "lse": LSESolver,
+            "ariane": ArianeSolver,
+            "none": lambda: None,
+        }
+        solver = solvers[parsed_args.solver]()
+
         result = convert_mak_to_geojson(
             parsed_args.input_file,
             output_path=parsed_args.output_file,
             include_stations=not parsed_args.no_stations,
             include_legs=not parsed_args.no_legs,
             include_passages=parsed_args.passages,
+            include_anchors=parsed_args.anchors,
+            color_by_origin=not parsed_args.no_colors,
+            solver=solver,
+            minify=parsed_args.minify,
         )
 
         if parsed_args.output_file is None:

{compass_lib-0.0.3 → compass_lib-0.0.4}/compass_lib/constants.py

@@ -82,3 +82,17 @@ FLAG_CHARS: dict[str, str] = {
 #: (positive = north, negative = south), NOT by comparing northing to this threshold.
 #: This constant is kept for reference and potential future use.
 UTM_SOUTHERN_HEMISPHERE_OFFSET: float = 10_000_000.0
+
+# -----------------------------------------------------------------------------
+# Solver Constraints
+# -----------------------------------------------------------------------------
+
+#: Maximum relative change to a shot's tape length during traverse adjustment
+#: (0.05 = 5 %).  The solver will never stretch or shrink a shot by more than
+#: this fraction of the original survey measurement.
+SOLVER_MAX_LENGTH_CHANGE: float = 0.15
+
+#: Maximum relative change to a shot's compass heading during traverse
+#: adjustment (0.15 = 15 %).  The solver will never rotate a shot's bearing
+#: or inclination by more than this fraction of the original survey reading.
+SOLVER_MAX_HEADING_CHANGE: float = 0.15

{compass_lib-0.0.3 → compass_lib-0.0.4}/compass_lib/enums.py

@@ -5,14 +5,14 @@ This module contains all enumerations used in Compass survey data formats,
 including units for measurements, file types, and various classification types.
 """
 
-from enum import Enum
+from enum import StrEnum
 from math import radians
 from math import tan
 
 from compass_lib.constants import FEET_TO_METERS
 
 
-class FileFormat(str, Enum):
+class FileFormat(StrEnum):
     """File format types for conversion operations.
 
     Attributes:
@@ -26,7 +26,7 @@ class FileFormat(str, Enum):
     GEOJSON = "geojson"
 
 
-class CompassFileType(str, Enum):
+class CompassFileType(StrEnum):
     """Types of Compass files.
 
     Attributes:
@@ -67,7 +67,7 @@ class CompassFileType(str, Enum):
         return mapping.get(ext_lower)
 
 
-class FileExtension(str, Enum):
+class FileExtension(StrEnum):
     """File extensions for various file formats (with dot).
 
     Attributes:
@@ -85,7 +85,7 @@ class FileExtension(str, Enum):
     GEOJSON = ".geojson"
 
 
-class FormatIdentifier(str, Enum):
+class FormatIdentifier(StrEnum):
     """Format identifiers used in JSON files.
 
     Attributes:
@@ -97,7 +97,7 @@ class FormatIdentifier(str, Enum):
     COMPASS_MAK = "compass_mak"
 
 
-class AzimuthUnit(str, Enum):
+class AzimuthUnit(StrEnum):
     """Unit for compass azimuth (bearing) measurements.
 
     Attributes:
@@ -128,7 +128,7 @@ class AzimuthUnit(str, Enum):
         return degrees
 
 
-class InclinationUnit(str, Enum):
+class InclinationUnit(StrEnum):
     """Unit for vertical angle (inclination) measurements.
 
     Attributes:
@@ -136,7 +136,9 @@ class InclinationUnit(str, Enum):
         PERCENT_GRADE: Percentage gradient (tan(angle) * 100)
         DEGREES_AND_MINUTES: Degrees with minutes notation
         GRADS: Gradians
-        DEPTH_GAUGE: Depth gauge reading
+        DEPTH_GAUGE: Delta depth (From_depth - To_depth) for underwater surveys.
+            Negative = descending (going deeper), positive = ascending.
+            Uses the same units as length measurements.
     """
 
     DEGREES = "D"
@@ -165,7 +167,7 @@ class InclinationUnit(str, Enum):
         return value
 
 
-class LengthUnit(str, Enum):
+class LengthUnit(StrEnum):
     """Unit for distance measurements.
 
     Attributes:
@@ -196,7 +198,7 @@ class LengthUnit(str, Enum):
         return feet
 
 
-class LrudAssociation(str, Enum):
+class LrudAssociation(StrEnum):
     """Indicates which station LRUD measurements are associated with.
 
     Attributes:
@@ -208,7 +210,7 @@ class LrudAssociation(str, Enum):
     TO = "T"
 
 
-class LrudItem(str, Enum):
+class LrudItem(StrEnum):
     """Individual LRUD dimension identifiers.
 
     Attributes:
@@ -224,7 +226,7 @@ class LrudItem(str, Enum):
     DOWN = "D"
 
 
-class ShotItem(str, Enum):
+class ShotItem(StrEnum):
     """Components of a shot measurement for format ordering.
 
     Attributes:
@@ -242,7 +244,7 @@ class ShotItem(str, Enum):
     BACKSIGHT_INCLINATION = "d"
 
 
-class Severity(str, Enum):
+class Severity(StrEnum):
     """Severity level for parse errors.
 
     Attributes:
@@ -254,7 +256,7 @@ class Severity(str, Enum):
     WARNING = "warning"
 
 
-class DrawOperation(str, Enum):
+class DrawOperation(StrEnum):
     """Drawing operations for plot commands.
 
     Attributes:
@@ -266,7 +268,7 @@ class DrawOperation(str, Enum):
     LINE_TO = "D"
 
 
-class Datum(str, Enum):
+class Datum(StrEnum):
     """Geodetic datum values supported by Compass.
 
     These are the standard datum values that can be used in MAK project files.
@@ -322,6 +324,42 @@ class Datum(str, Enum):
     WGS_1972 = "WGS 1972"
     WGS_1984 = "WGS 1984"
 
+    def get_utm_epsg(self, zone: int, northern: bool) -> str:
+        """Get the EPSG code for a UTM zone with this datum.
+
+        Args:
+            zone: UTM zone number (1-60)
+            northern: True for northern hemisphere
+
+        Returns:
+            EPSG code string (e.g., "EPSG:26717" for NAD27 UTM Zone 17N)
+        """
+        zone = abs(zone)
+
+        match self:
+            case Datum.NORTH_AMERICAN_1927:
+                # NAD27 / UTM: EPSG:26701-26722 (zones 1-22 north)
+                return f"EPSG:{26700 + zone}"
+
+            case Datum.NORTH_AMERICAN_1983:
+                # NAD83 / UTM: EPSG:26901-26923 (zones 1-23 north)
+                return f"EPSG:{26900 + zone}"
+
+            case Datum.WGS_1972:
+                # WGS72 / UTM: EPSG:32201-32260 (north), EPSG:32301-32360 (south)
+                if northern:
+                    return f"EPSG:{32200 + zone}"
+                return f"EPSG:{32300 + zone}"
+
+            case Datum.WGS_1984:
+                # WGS84 / UTM: EPSG:32601-32660 (north), EPSG:32701-32760 (south)
+                if northern:
+                    return f"EPSG:{32600 + zone}"
+                return f"EPSG:{32700 + zone}"
+
+            case _:
+                raise NotImplementedError(f"This DATUM: `{self}` is not supported")
+
     @classmethod
     def normalize(cls, value: str | None) -> "Datum | None":
         """Normalize and validate a datum string to a Datum enum value.