pingmapper 5.4.5__tar.gz → 5.4.6__tar.gz

{pingmapper-5.4.5 → pingmapper-5.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pingmapper
-Version: 5.4.5
+Version: 5.4.6
 Summary: Open-source interface for processing recreation-grade side scan sonar datasets and reproducibly mapping benthic habitat
 Author: Cameron Bodine, Daniel Buscombe, Iury T Simoes-Sousa
 Author-email: bodine.cs@gmail.email
@@ -168,6 +168,20 @@ python -m pingmapper gui
    pixi run -e full gui    # GUI with ML support
    ```
 
+### Verify Installation
+
+Run a lightweight self-check (same check used in CI):
+
+```bash
+python -m pingmapper check
+```
+
+Optional longer end-to-end processing validation:
+
+```bash
+python -m pingmapper test
+```
+
 ## Ready to get started?
 
 Follow the installation and testing instructions to [Get Started!](https://cameronbodine.github.io/PINGMapper/docs/gettingstarted)

{pingmapper-5.4.5 → pingmapper-5.4.6}/README.md

@@ -130,6 +130,20 @@ python -m pingmapper gui
    pixi run -e full gui    # GUI with ML support
    ```
 
+### Verify Installation
+
+Run a lightweight self-check (same check used in CI):
+
+```bash
+python -m pingmapper check
+```
+
+Optional longer end-to-end processing validation:
+
+```bash
+python -m pingmapper test
+```
+
 ## Ready to get started?
 
 Follow the installation and testing instructions to [Get Started!](https://cameronbodine.github.io/PINGMapper/docs/gettingstarted)

{pingmapper-5.4.5 → pingmapper-5.4.6}/pingmapper/__main__.py

@@ -49,5 +49,12 @@ def main(process):
         from pingmapper.test_PINGMapper import test
         test(2)
 
+    elif process in ('check', 'test_unit'):
+        print('\n\nRunning PINGMapper self-check...\n\n')
+        from pingmapper.self_check import run_self_check
+        return run_self_check(verbose=True)
+
+    return 0
+
 if __name__ == "__main__":
-    main(to_do)
+    sys.exit(main(to_do))

{pingmapper-5.4.5 → pingmapper-5.4.6}/pingmapper/class_rectObj.py

@@ -327,10 +327,7 @@ class rectObj(sonObj):
                     if self.egn_stretch > 0:
                         self._egnDoStretch()
 
-            img = self._reserve_zero_for_nodata(
-                self.sonDat,
-                preserve_zeros=(not bool(getattr(self, 'son8bit', False))),
-            )
+            img = self._reserve_zero_for_nodata(self.sonDat, preserve_zeros=True)
             img = self._prepare_export_uint16(img)
             vals = img[img > 0]
             if vals.size == 0:
@@ -1864,10 +1861,7 @@ class rectObj(sonObj):
             col = df[xPix].to_numpy().astype(int)
             data = df[sonCol].to_numpy()
             if son:
-                data = self._reserve_zero_for_nodata(
-                    data,
-                    preserve_zeros=(not bool(getattr(self, 'son8bit', False))),
-                )
+                data = self._reserve_zero_for_nodata(data, preserve_zeros=True)
             apply_post_rect_colormap = use_16bit and self._rect_colormap_selected(son=son)
             source_scale_bounds = None
             if apply_post_rect_colormap:
@@ -2727,10 +2721,7 @@ class rectObj(sonObj):
 
             img = self.sonDat.copy()
             if son:
-                img = self._reserve_zero_for_nodata(
-                    img,
-                    preserve_zeros=(not bool(getattr(self, 'son8bit', False))),
-                )
+                img = self._reserve_zero_for_nodata(img, preserve_zeros=True)
             apply_post_rect_colormap = use_16bit and self._rect_colormap_selected(son=son)
             source_scale_bounds = None
             if apply_post_rect_colormap:
@@ -2821,10 +2812,7 @@ class rectObj(sonObj):
 
             img = self.sonDat
             if son:
-                img = self._reserve_zero_for_nodata(
-                    img,
-                    preserve_zeros=(not bool(getattr(self, 'son8bit', False))),
-                )
+                img = self._reserve_zero_for_nodata(img, preserve_zeros=True)
             apply_post_rect_colormap = son and use_16bit and self._rect_colormap_selected(son=son)
             source_scale_bounds = None
             if apply_post_rect_colormap:

pingmapper-5.4.6/pingmapper/self_check.py

@@ -0,0 +1,62 @@
+"""Lightweight install/runtime checks for CI and end-user validation."""
+
+from __future__ import annotations
+
+import importlib
+import sys
+import unittest
+
+
+REQUIRED_MODULES = [
+    "osgeo",
+    "numpy",
+    "pandas",
+    "geopandas",
+    "rasterio",
+    "pyproj",
+    "cv2",
+    "pinginstaller",
+    "pingwizard",
+    "pingverter",
+]
+
+
+def _missing_required_modules() -> list[str]:
+    """Return required modules that fail to import."""
+    missing = []
+    for mod_name in REQUIRED_MODULES:
+        try:
+            importlib.import_module(mod_name)
+        except Exception:
+            missing.append(mod_name)
+    return missing
+
+
+def run_self_check(verbose: bool = True) -> int:
+    """Run dependency checks and unit tests. Returns process exit code."""
+    print("\nPINGMapper self-check\n")
+
+    missing = _missing_required_modules()
+    if missing:
+        print("Missing required modules:")
+        for name in missing:
+            print(f" - {name}")
+        print("\nSelf-check failed: install appears incomplete.")
+        return 1
+
+    print("Dependency import checks passed.")
+
+    suite = unittest.defaultTestLoader.loadTestsFromName("pingmapper.test_dq_filter")
+    runner = unittest.TextTestRunner(verbosity=2 if verbose else 1)
+    result = runner.run(suite)
+
+    if not result.wasSuccessful():
+        print("\nSelf-check failed: unit tests did not pass.")
+        return 1
+
+    print("\nSelf-check passed.")
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(run_self_check())

{pingmapper-5.4.5 → pingmapper-5.4.6}/pingmapper/test_PINGMapper.py

@@ -72,7 +72,7 @@ def test(ds):
     #     ds = int(sys.argv[1])
     # else:
     #     print("\n\nERROR: \nPlease enter argument to choose which test file to process:")
-    #     print("1 = Short recording \n2 = Long recording \n\nSYNTAX: python test_PINGMapper.py <1 or 2>\n\n")
+    #     print("1 = Short recording \n2 = Long recording \n\nSYNTAX: python -m pingmapper test <1 or 2>\n\n")
     #     sys.exit()
 
     #################
@@ -87,15 +87,15 @@ def test(ds):
         download_name = 'sample_recording'
     else:
         print("\n\nERROR: \nPlease enter argument to choose which test file to process:")
-        print("1 = Short recording \n2 = Long recording \n\nSYNTAX: python test_PINGMapper.py <1 or 2>\n\n")
+        print("1 = Short recording \n2 = Long recording \n\nSYNTAX: python -m pingmapper test <1 or 2>\n\n")
         sys.exit()
 
-    repo_root = PACKAGE_DIR
-    d = os.environ.get(
-        'PINGMAPPER_DATA_DIR',
-        os.path.join(repo_root, '.data'),
-    )
-    exampleDir = os.path.join(d, 'example_data')
+    repo_root = PACKAGE_DIR
+    d = os.environ.get(
+        'PINGMAPPER_DATA_DIR',
+        os.path.join(repo_root, '.data'),
+    )
+    exampleDir = os.path.join(d, 'example_data')
     ds_path = os.path.join(exampleDir, ds_name)
     ds_path = os.path.normpath(ds_path)
 
@@ -122,12 +122,12 @@ def test(ds):
     # Path to data/output
     inFile = ds_path+'.DAT'
     sonPath = ds_path
-    proj_base_dir = os.environ.get(
-        'PINGMAPPER_TEST_OUTPUT_DIR',
-        os.path.join(d, 'test_runs'),
-    )
-
-    projDir = os.path.join(proj_base_dir, 'PINGMapper-'+ds_name)
+    proj_base_dir = os.environ.get(
+        'PINGMAPPER_TEST_OUTPUT_DIR',
+        os.path.join(d, 'test_runs'),
+    )
+
+    projDir = os.path.join(proj_base_dir, 'PINGMapper-'+ds_name)
 
     inFile = os.path.abspath(inFile)
     sonPath = os.path.abspath(sonPath)
@@ -246,7 +246,7 @@ def test(ds):
     if project_mode == 0:
         # Create new project
         if not os.path.exists(projDir):
-            os.makedirs(projDir, exist_ok=False)
+            os.makedirs(projDir, exist_ok=False)
         else:
             projectMode_1_inval()
 
@@ -255,7 +255,7 @@ def test(ds):
         if os.path.exists(projDir):
             shutil.rmtree(projDir)
 
-        os.makedirs(projDir, exist_ok=False)
+        os.makedirs(projDir, exist_ok=False)
 
     elif project_mode == 2:
         # Update project

pingmapper-5.4.6/pingmapper/version.py

@@ -0,0 +1 @@
+__version__ = '5.4.6'

{pingmapper-5.4.5 → pingmapper-5.4.6}/pingmapper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pingmapper
-Version: 5.4.5
+Version: 5.4.6
 Summary: Open-source interface for processing recreation-grade side scan sonar datasets and reproducibly mapping benthic habitat
 Author: Cameron Bodine, Daniel Buscombe, Iury T Simoes-Sousa
 Author-email: bodine.cs@gmail.email
@@ -168,6 +168,20 @@ python -m pingmapper gui
    pixi run -e full gui    # GUI with ML support
    ```
 
+### Verify Installation
+
+Run a lightweight self-check (same check used in CI):
+
+```bash
+python -m pingmapper check
+```
+
+Optional longer end-to-end processing validation:
+
+```bash
+python -m pingmapper test
+```
+
 ## Ready to get started?
 
 Follow the installation and testing instructions to [Get Started!](https://cameronbodine.github.io/PINGMapper/docs/gettingstarted)

{pingmapper-5.4.5 → pingmapper-5.4.6}/pingmapper.egg-info/SOURCES.txt

@@ -20,6 +20,7 @@ pingmapper/main_readFiles.py
 pingmapper/main_rectify.py
 pingmapper/nonGUI_batch_main.py
 pingmapper/nonGui_main.py
+pingmapper/self_check.py
 pingmapper/test_PINGMapper.py
 pingmapper/test_dq_filter.py
 pingmapper/test_time.py

{pingmapper-5.4.5 → pingmapper-5.4.6}/pyproject.toml

@@ -105,5 +105,7 @@ full = { features = ["ml"], solve-group = "default" }
 pingmapper = "python -m pingwizard"
 gui = "python -m pingmapper gui"
 gui-batch = "python -m pingmapper gui_batch"
+check = "python -m pingmapper check"
+test-unit = "python -m pingmapper test_unit"
 test = "python -m pingmapper test"
 test-large = "python -m pingmapper test_large"

pingmapper-5.4.5/pingmapper/version.py

@@ -1 +0,0 @@
-__version__ = '5.4.5'