viewtif 0.1.5__tar.gz → 0.1.6__tar.gz

viewtif-0.1.6/.gitignore

@@ -0,0 +1,8 @@
+# virtual environments
+.venv
+.venv-test
+
+# build artifacts
+dist/
+build/
+*.egg-info/

{viewtif-0.1.5 → viewtif-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: viewtif
-Version: 0.1.5
+Version: 0.1.6
 Summary: Simple GeoTIFF viewer with optional shapefile overlay.
 Project-URL: Homepage, https://github.com/nkeikon/tifviewer
 Project-URL: Source, https://github.com/nkeikon/tifviewer
@@ -19,6 +19,9 @@ Requires-Dist: shapely>=2.0; extra == 'geo'
 Description-Content-Type: text/markdown
 
 # viewtif
+[![Downloads](https://static.pepy.tech/badge/viewtif)](https://pepy.tech/project/viewtif)
+[![PyPI version](https://img.shields.io/pypi/v/viewtif)](https://pypi.org/project/viewtif/)
+[![Python versions](https://img.shields.io/pypi/pyversions/viewtif)](https://pypi.org/project/viewtif/)
 
 A lightweight GeoTIFF viewer for quick visualization directly from the command line.  
 
@@ -31,35 +34,61 @@ You can visualize single-band GeoTIFFs, RGB composites, and shapefile overlays i
 ```bash
 pip install viewtif
 ```
+> **Note:** On Linux, you may need python3-tk, libqt5gui5, or PySide6 dependencies.
+> 
+>`viewtif` requires a graphical display environment.  
+> It may not run properly on headless systems (e.g., HPC compute nodes or remote servers without X11 forwarding).
 
-If you want to enable shapefile overlays, install with optional dependencies:
+### Optional features
+#### Shapefile overlay support
 ```bash
 pip install "viewtif[geo]"
 ```
-Note for macOS(zsh) users:
-Make sure to include the quotes, or zsh will interpret it as a pattern.
+> **Note:** For macOS(zsh) users:
+> Make sure to include the quotes, or zsh will interpret it as a pattern.
+
+#### HDF/HDF5 support
+```bash
+brew install gdal     # macOS
+sudo apt install gdal-bin python3-gdal  # Linux
+pip install GDAL
+```
+> **Note:** GDAL is required to open `.hdf`, .`h5`, and `.hdf5` files. If it’s missing, viewtif will display: `RuntimeError: HDF support requires GDAL.`
 
 ## Quick Start
 ```bash
 # View a GeoTIFF
-viewtif examples/sample_data/ECOSTRESS_LST.tif
-
-# View with shapefile overlay
-viewtif examples/sample_data/ECOSTRESS_LST.tif \
-  --shapefile examples/sample_data/Zip_Codes.shp
+viewtif ECOSTRESS_LST.tif
 
 # View an RGB composite
 viewtif --rgbfiles \
-  examples/sample_data/HLS_B04.tif \
-  examples/sample_data/HLS_B03.tif \
-  examples/sample_data/HLS_B02.tif
+  HLS_B04.tif \
+  HLS_B03.tif \
+  HLS_B02.tif
+
+# View with shapefile overlay
+viewtif ECOSTRESS_LST.tif \
+  --shapefile Zip_Codes.shp
+```
+### Update in v1.0.6
+`viewtif` can open `.hdf`, `.h5`, and `.hdf5` files that contain multiple subdatasets. When opened, it lists available subdatasets and lets you view one by index. You can also specify a band to display (default is the first band) or change bands interactively with '[' and ']'.
+```bash
+# List subdatasets
+viewtif AG100.v003.33.-107.0001.h5
+
+# View a specific subdataset
+viewtif AG100.v003.33.-107.0001.h5 --subset 1
 
+# View a specific subdataset and band
+viewtif AG100.v003.33.-107.0001.h5 --subset 1 --band 3
 ```
+> **Note:** Some datasets (perhaps the majority of .hdf files) lack CRS information encoded, so shapefile overlays may not work. In that case, viewtif will display:
+`[WARN] raster lacks CRS/transform; cannot place overlays.`
 
 ## Controls
 | Key                  | Action                                  |
 | -------------------- | --------------------------------------- |
-| `+` / `-`            | Zoom in / out                           |
+| `+` / `-` or mouse / trackpad            | Zoom in / out                           |
 | Arrow keys or `WASD` | Pan                                     |
 | `C` / `V`            | Increase / decrease contrast            |
 | `G` / `H`            | Increase / decrease gamma               |
@@ -68,8 +97,8 @@ viewtif --rgbfiles \
 | `R`                  | Reset view                              |
 
 ## Features
-- Command-line driven GeoTIFF viewer
-- Supports single-band or RGB composite display.
+- Command-line driven GeoTIFF viewer.
+- Supports single-band, RGB composite, and HDF/HDF5 subdatasets.
 - Optional shapefile overlay for geographic context.
 - Adjustable contrast, gamma, and colormap.
 - Fast preview using rasterio and PySide6.
@@ -78,14 +107,15 @@ viewtif --rgbfiles \
 - ECOSTRESS_LST.tif
 - Zip_Codes.shp and associated files
 - HLS_B04.tif, HLS_B03.tif, HLS_B02.tif (RGB sample)
+- AG100.v003.33.-107.0001.h5 (HDF5 file)
 
 ## Credit & License
 `viewtif` was inspired by the NASA JPL Thermal Viewer — Semi-Automated Georeferencer (GeoViewer v1.12) developed by Jake Longenecker (University of Miami Rosenstiel School of Marine, Atmospheric & Earth Science) while at the NASA Jet Propulsion Laboratory, California Institute of Technology, with inspiration from JPL’s ECOSTRESS geolocation batch workflow by Andrew Alamillo. The original GeoViewer was released under the MIT License (2025) and may be freely adapted with citation.
 
-# Citation
-Longenecker, Jake; Lee, Christine; Hulley, Glynn; Cawse-Nicholson, Kerry; Purkis, Sam; Gleason, Art; Otis, Dan; Galdamez,Ileana; Meiseles, Jacquelyn. GeoViewer v1.12: NASA JPL Thermal Viewer—Semi-Automated Georeferencer User Guide & Reference Manual. Jet Propulsion Laboratory, California Institute of Technology, 2025. PDF.
+## Citation
+Longenecker, Jake; Lee, Christine; Hulley, Glynn; Cawse-Nicholson, Kerry; Purkis, Sam; Gleason, Art; Otis, Dan; Galdamez, Ileana; Meiseles, Jacquelyn. GeoViewer v1.12: NASA JPL Thermal Viewer—Semi-Automated Georeferencer User Guide & Reference Manual. Jet Propulsion Laboratory, California Institute of Technology, 2025. PDF.
 
-# License
+## License
 This project is released under the MIT License.
 
 ## Contributors

viewtif-0.1.6/README.md

@@ -0,0 +1,103 @@
+# viewtif
+[![Downloads](https://static.pepy.tech/badge/viewtif)](https://pepy.tech/project/viewtif)
+[![PyPI version](https://img.shields.io/pypi/v/viewtif)](https://pypi.org/project/viewtif/)
+[![Python versions](https://img.shields.io/pypi/pyversions/viewtif)](https://pypi.org/project/viewtif/)
+
+A lightweight GeoTIFF viewer for quick visualization directly from the command line.  
+
+You can visualize single-band GeoTIFFs, RGB composites, and shapefile overlays in a simple Qt-based window.
+
+---
+
+## Installation
+
+```bash
+pip install viewtif
+```
+> **Note:** On Linux, you may need python3-tk, libqt5gui5, or PySide6 dependencies.
+> 
+>`viewtif` requires a graphical display environment.  
+> It may not run properly on headless systems (e.g., HPC compute nodes or remote servers without X11 forwarding).
+
+### Optional features
+#### Shapefile overlay support
+```bash
+pip install "viewtif[geo]"
+```
+> **Note:** For macOS(zsh) users:
+> Make sure to include the quotes, or zsh will interpret it as a pattern.
+
+#### HDF/HDF5 support
+```bash
+brew install gdal     # macOS
+sudo apt install gdal-bin python3-gdal  # Linux
+pip install GDAL
+```
+> **Note:** GDAL is required to open `.hdf`, .`h5`, and `.hdf5` files. If it’s missing, viewtif will display: `RuntimeError: HDF support requires GDAL.`
+
+## Quick Start
+```bash
+# View a GeoTIFF
+viewtif ECOSTRESS_LST.tif
+
+# View an RGB composite
+viewtif --rgbfiles \
+  HLS_B04.tif \
+  HLS_B03.tif \
+  HLS_B02.tif
+
+# View with shapefile overlay
+viewtif ECOSTRESS_LST.tif \
+  --shapefile Zip_Codes.shp
+```
+### Update in v1.0.6
+`viewtif` can open `.hdf`, `.h5`, and `.hdf5` files that contain multiple subdatasets. When opened, it lists available subdatasets and lets you view one by index. You can also specify a band to display (default is the first band) or change bands interactively with '[' and ']'.
+```bash
+# List subdatasets
+viewtif AG100.v003.33.-107.0001.h5
+
+# View a specific subdataset
+viewtif AG100.v003.33.-107.0001.h5 --subset 1
+
+# View a specific subdataset and band
+viewtif AG100.v003.33.-107.0001.h5 --subset 1 --band 3
+```
+> **Note:** Some datasets (perhaps the majority of .hdf files) lack CRS information encoded, so shapefile overlays may not work. In that case, viewtif will display:
+`[WARN] raster lacks CRS/transform; cannot place overlays.`
+
+## Controls
+| Key                  | Action                                  |
+| -------------------- | --------------------------------------- |
+| `+` / `-` or mouse / trackpad            | Zoom in / out                           |
+| Arrow keys or `WASD` | Pan                                     |
+| `C` / `V`            | Increase / decrease contrast            |
+| `G` / `H`            | Increase / decrease gamma               |
+| `M`                  | Toggle colormap (`viridis` ↔ `magma`)   |
+| `[` / `]`            | Previous / next band (single-band only) |
+| `R`                  | Reset view                              |
+
+## Features
+- Command-line driven GeoTIFF viewer.
+- Supports single-band, RGB composite, and HDF/HDF5 subdatasets.
+- Optional shapefile overlay for geographic context.
+- Adjustable contrast, gamma, and colormap.
+- Fast preview using rasterio and PySide6.
+
+## Example Data
+- ECOSTRESS_LST.tif
+- Zip_Codes.shp and associated files
+- HLS_B04.tif, HLS_B03.tif, HLS_B02.tif (RGB sample)
+- AG100.v003.33.-107.0001.h5 (HDF5 file)
+
+## Credit & License
+`viewtif` was inspired by the NASA JPL Thermal Viewer — Semi-Automated Georeferencer (GeoViewer v1.12) developed by Jake Longenecker (University of Miami Rosenstiel School of Marine, Atmospheric & Earth Science) while at the NASA Jet Propulsion Laboratory, California Institute of Technology, with inspiration from JPL’s ECOSTRESS geolocation batch workflow by Andrew Alamillo. The original GeoViewer was released under the MIT License (2025) and may be freely adapted with citation.
+
+## Citation
+Longenecker, Jake; Lee, Christine; Hulley, Glynn; Cawse-Nicholson, Kerry; Purkis, Sam; Gleason, Art; Otis, Dan; Galdamez, Ileana; Meiseles, Jacquelyn. GeoViewer v1.12: NASA JPL Thermal Viewer—Semi-Automated Georeferencer User Guide & Reference Manual. Jet Propulsion Laboratory, California Institute of Technology, 2025. PDF.
+
+## License
+This project is released under the MIT License.
+
+## Contributors
+- [@HarshShinde0](https://github.com/HarshShinde0) — added mouse-wheel and trackpad zoom support
+

{viewtif-0.1.5 → viewtif-0.1.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "viewtif"
-version = "0.1.5"
+version = "0.1.6"
 description = "Simple GeoTIFF viewer with optional shapefile overlay."
 readme = "README.md"
 requires-python = ">=3.9"

{viewtif-0.1.5 → viewtif-0.1.6}/src/viewtif/tif_viewer.py

@@ -56,6 +56,7 @@ except Exception:
 # -------------------------- QGraphicsView tweaks -------------------------- #
 class RasterView(QGraphicsView):
     def __init__(self, *args, **kwargs):
+        import numpy as np
         super().__init__(*args, **kwargs)
         self.setRenderHint(QPainter.RenderHint.SmoothPixmapTransform, False)
         self.setDragMode(QGraphicsView.DragMode.ScrollHandDrag)
@@ -101,6 +102,7 @@ class TiffViewer(QMainWindow):
         shapefiles: list[str] | None = None,
         shp_color: str = "white",
         shp_width: float = 2,
+        subset: int | None = None,
     ):
         super().__init__()
 
@@ -141,38 +143,118 @@ class TiffViewer(QMainWindow):
             self.tif_path = self.tif_path or (os.path.commonprefix([red, green, blue]) or red)
 
         elif tif_path:
-            with rasterio.open(tif_path) as src:
-                self._transform = src.transform
-                self._crs = src.crs
-                if rgb is not None:
-                    bands = [src.read(b, out_shape=(src.height // self._scale_arg, src.width // self._scale_arg))
-                             for b in rgb]
-                    arr = np.stack(bands, axis=-1).astype(np.float32)
-                    nd = src.nodata
-                    if nd is not None:
-                        arr[arr == nd] = np.nan
+            # --------------------- Detect HDF/HDF5 --------------------- #
+            if tif_path.lower().endswith((".hdf", ".h5", ".hdf5")):
+                try:
+                    from osgeo import gdal
+                    gdal.UseExceptions()
+
+                    ds = gdal.Open(tif_path)
+                    subs = ds.GetSubDatasets()
+
+                    if not subs:
+                        raise ValueError("No subdatasets found in HDF/HDF5 file.")
+
+                    print(f"Found {len(subs)} subdatasets in {os.path.basename(tif_path)}:")
+                    for i, (_, desc) in enumerate(subs):
+                        print(f"[{i}] {desc}")
+
+                    # Only list subsets if --subset not given
+                    if subset is None:
+                        print("\nUse --subset N to open a specific subdataset.")
+                        sys.exit(0)
+
+                    # Validate subset index
+                    if subset < 0 or subset >= len(subs):
+                        raise ValueError(f"Invalid subset index {subset}. Valid range: 0–{len(subs)-1}")
+
+                    sub_name, desc = subs[subset]
+                    print(f"\nOpening subdataset [{subset}]: {desc}")
+                    sub_ds = gdal.Open(sub_name)
+
+                    # --- Read once ---
+                    arr = sub_ds.ReadAsArray().astype(np.float32)
+                    #print(f"Raw array shape from GDAL: {arr.shape} (ndim={arr.ndim})")
+
+                    # --- Normalize shape ---
+                    arr = np.squeeze(arr)
+                    if arr.ndim == 3:
+                        # Convert from (bands, rows, cols) → (rows, cols, bands)
+                        arr = np.transpose(arr, (1, 2, 0))
+                        #print(f"Transposed to {arr.shape} (rows, cols, bands)")
+                    elif arr.ndim == 2:
+                        print("Single-band dataset.")
+                    else:
+                        raise ValueError(f"Unexpected array shape {arr.shape}")
+
+                    # --- Downsample large arrays for responsiveness ---
+                    h, w = arr.shape[:2]
+                    if h * w > 4_000_000:
+                        step = max(2, int((h * w / 4_000_000) ** 0.5))
+                        arr = arr[::step, ::step] if arr.ndim == 2 else arr[::step, ::step, :]
+                        print(f"⚠️ Large dataset preview: downsampled by {step}x")
+
+                    # --- Final assignments ---
                     self.data = arr
-                    self.band_count = 3
-                else:
-                    arr = src.read(
-                        self.band,
-                        out_shape=(src.height // self._scale_arg, src.width // self._scale_arg)
-                    ).astype(np.float32)
-                    nd = src.nodata
-                    if nd is not None:
-                        arr[arr == nd] = np.nan
-                    self.data = arr
-                    self.band_count = src.count
-
-                    # single-band display range (fast stats or fallback)
-                    try:
-                        stats = src.stats(self.band)
-                        if stats and stats.min is not None and stats.max is not None:
-                            self.vmin, self.vmax = stats.min, stats.max
-                        else:
-                            raise ValueError("No stats in file")
-                    except Exception:
-                        self.vmin, self.vmax = np.nanmin(arr), np.nanmax(arr)
+                    self._transform = None
+                    self._crs = None
+                    self.band_count = arr.shape[2] if arr.ndim == 3 else 1
+                    self.band_index = 0
+                    self.vmin, self.vmax = np.nanmin(arr), np.nanmax(arr)
+
+                    if self.band_count > 1:
+                        print(f"This subdataset has {self.band_count} bands — switch with [ and ] keys.")
+                    else:
+                        print("This subdataset has 1 band.")
+
+                    # --- If user specified --band, start there ---
+                    if self.band and self.band <= self.band_count:
+                        self.band_index = self.band - 1
+                        print(f"Opening band {self.band}/{self.band_count}")
+                    else:
+                        self.band_index = 0
+
+                except ImportError:
+                    raise RuntimeError(
+                        "HDF support requires GDAL.\n"
+                        "Install it first (e.g., brew install gdal && pip install GDAL)"
+                    )
+
+            # --------------------- Regular GeoTIFF --------------------- #
+            else:
+                with rasterio.open(tif_path) as src:
+                    self._transform = src.transform
+                    self._crs = src.crs
+                    if rgb is not None:
+                        bands = [src.read(b, out_shape=(src.height // self._scale_arg, src.width // self._scale_arg))
+                                for b in rgb]
+                        arr = np.stack(bands, axis=-1).astype(np.float32)
+                        nd = src.nodata
+                        if nd is not None:
+                            arr[arr == nd] = np.nan
+                        self.data = arr
+                        self.band_count = 3
+                    else:
+                        arr = src.read(
+                            self.band,
+                            out_shape=(src.height // self._scale_arg, src.width // self._scale_arg)
+                        ).astype(np.float32)
+                        nd = src.nodata
+                        if nd is not None:
+                            arr[arr == nd] = np.nan
+                        self.data = arr
+                        self.band_count = src.count
+
+                        # single-band display range (fast stats or fallback)
+                        try:
+                            stats = src.stats(self.band)
+                            if stats and stats.min is not None and stats.max is not None:
+                                self.vmin, self.vmax = stats.min, stats.max
+                            else:
+                                raise ValueError("No stats in file")
+                        except Exception:
+                            self.vmin, self.vmax = np.nanmin(arr), np.nanmax(arr)
+
         else:
             raise ValueError("Provide a TIFF path or --rgbfiles.")
 
@@ -339,6 +421,10 @@ class TiffViewer(QMainWindow):
             self.setWindowTitle(f"RGB ({', '.join(names)})")
         elif self.rgb_mode and self.rgb:
             self.setWindowTitle(f"RGB {self.rgb} — {os.path.basename(self.tif_path)}")
+        elif hasattr(self, "band_index"):
+            self.setWindowTitle(
+                f"Band {self.band_index + 1}/{self.band_count} — {os.path.basename(self.tif_path)}"
+            )
         else:
             self.setWindowTitle(f"Band {self.band}/{self.band_count} — {os.path.basename(self.tif_path)}")
 
@@ -371,10 +457,44 @@ class TiffViewer(QMainWindow):
             return rgb
 
     def update_pixmap(self):
-        rgb = self._render_rgb()
+        # --- Select display data ---
+        if hasattr(self, "band_index"):
+            # HDF or scientific multi-band
+            if self.data.ndim == 3:
+                a = self.data[:, :, self.band_index]
+            else:
+                a = self.data
+            rgb = None
+        else:
+            # Regular GeoTIFF (could be RGB or single-band)
+            if self.rgb_mode:  # user explicitly passed --rgb or --rgbtiles
+                rgb = self.data
+                a = None
+            else:
+                a = self.data
+                rgb = None
+        # ----------------------------
+
+        # --- Render image ---
+        if rgb is None:
+            # Grayscale rendering for single-band (scientific) data
+            finite = np.isfinite(a)
+            rng = max(np.nanmax(a) - np.nanmin(a), 1e-12)
+            norm = np.zeros_like(a, dtype=np.float32)
+            if np.any(finite):
+                norm[finite] = (a[finite] - np.nanmin(a)) / rng
+            norm = np.clip(norm, 0, 1)
+            norm = np.power(norm * self.contrast, self.gamma)
+            cmap = getattr(cm, self.cmap_name, cm.viridis)
+            rgb = (cmap(norm)[..., :3] * 255).astype(np.uint8)
+        else:
+            # True RGB mode (unchanged)
+            rgb = self._render_rgb()
+        # ----------------------
+
         h, w, _ = rgb.shape
         self._last_rgb = rgb
-        qimg = QImage(self._last_rgb.data, w, h, 3 * w, QImage.Format.Format_RGB888)
+        qimg = QImage(rgb.data, w, h, 3 * w, QImage.Format.Format_RGB888)
         pix = QPixmap.fromImage(qimg)
         if self.pixmap_item is None:
             self.pixmap_item = QGraphicsPixmapItem(pix)
@@ -433,13 +553,24 @@ class TiffViewer(QMainWindow):
             self.cmap_name, self.alt_cmap_name = self.alt_cmap_name, self.cmap_name
             self.update_pixmap()
 
-        # Band switch (single-band)
-        elif not self.rgb_mode and k == Qt.Key.Key_BracketRight:
-            new_band = self.band + 1 if self.band < self.band_count else 1
-            self.load_band(new_band)
-        elif not self.rgb_mode and k == Qt.Key.Key_BracketLeft:
-            new_band = self.band - 1 if self.band > 1 else self.band_count
-            self.load_band(new_band)
+        # Band switch
+        elif k == Qt.Key.Key_BracketRight:
+            if hasattr(self, "band_index"):  # HDF/NetCDF mode
+                self.band_index = (self.band_index + 1) % self.band_count
+                self.update_pixmap()
+                self.update_title()
+            elif not self.rgb_mode:  # GeoTIFF single-band mode
+                new_band = self.band + 1 if self.band < self.band_count else 1
+                self.load_band(new_band)
+
+        elif k == Qt.Key.Key_BracketLeft:
+            if hasattr(self, "band_index"):  # HDF/NetCDF mode
+                self.band_index = (self.band_index - 1) % self.band_count
+                self.update_pixmap()
+                self.update_title()
+            elif not self.rgb_mode:  # GeoTIFF single-band mode
+                new_band = self.band - 1 if self.band > 1 else self.band_count
+                self.load_band(new_band)
 
         elif k == Qt.Key.Key_R:
             self.contrast = 1.0
@@ -488,6 +619,7 @@ def run_viewer(
     shapefile=None,
     shp_color=None,
     shp_width=None,
+    subset=None,
 ):
     """Launch the TiffViewer app"""
     app = QApplication(sys.argv)
@@ -500,6 +632,7 @@ def run_viewer(
         shapefiles=shapefile,
         shp_color=shp_color,
         shp_width=shp_width,
+        subset=subset,
     )
     win.show()
     sys.exit(app.exec())
@@ -507,6 +640,7 @@ def run_viewer(
 import click
 
 @click.command()
+@click.version_option("1.0.6", prog_name="viewtif")
 @click.argument("tif_path", required=False)
 @click.option("--band", default=1, show_default=True, type=int, help="Band number to display")
 @click.option("--scale", default=1.0, show_default=True, type=float, help="Scale factor for display")
@@ -515,9 +649,9 @@ import click
 @click.option("--shapefile", multiple=True, type=str, help="One or more shapefiles to overlay")
 @click.option("--shp-color", default="white", show_default=True, help="Overlay color (name or #RRGGBB).")
 @click.option("--shp-width", default=1.0, show_default=True, type=float, help="Overlay line width (screen pixels).")
-def main(tif_path, band, scale, rgb, rgbfiles, shapefile, shp_color, shp_width):
+@click.option("--subset", default=None, type=int, help="Open specific subdataset index in .hdf/.h5 file")
+def main(tif_path, band, scale, rgb, rgbfiles, shapefile, shp_color, shp_width, subset):
     """Lightweight GeoTIFF viewer."""
-
     # --- Warn early if shapefile requested but geopandas missing ---
     if shapefile and not HAVE_GEO:
         print(
@@ -535,9 +669,9 @@ def main(tif_path, band, scale, rgb, rgbfiles, shapefile, shp_color, shp_width):
         shapefile=shapefile,
         shp_color=shp_color,
         shp_width=shp_width,
+        subset=subset,
     )
 
-
 if __name__ == "__main__":
     main()
 

viewtif-0.1.5/.gitignore

@@ -1,4 +0,0 @@
-.venv/
-dist/
-__pycache__/
-*.pyc

viewtif-0.1.5/README.md

@@ -1,73 +0,0 @@
-# viewtif
-
-A lightweight GeoTIFF viewer for quick visualization directly from the command line.  
-
-You can visualize single-band GeoTIFFs, RGB composites, and shapefile overlays in a simple Qt-based window.
-
----
-
-## Installation
-
-```bash
-pip install viewtif
-```
-
-If you want to enable shapefile overlays, install with optional dependencies:
-```bash
-pip install "viewtif[geo]"
-```
-Note for macOS(zsh) users:
-Make sure to include the quotes, or zsh will interpret it as a pattern.
-
-## Quick Start
-```bash
-# View a GeoTIFF
-viewtif examples/sample_data/ECOSTRESS_LST.tif
-
-# View with shapefile overlay
-viewtif examples/sample_data/ECOSTRESS_LST.tif \
-  --shapefile examples/sample_data/Zip_Codes.shp
-
-# View an RGB composite
-viewtif --rgbfiles \
-  examples/sample_data/HLS_B04.tif \
-  examples/sample_data/HLS_B03.tif \
-  examples/sample_data/HLS_B02.tif
-
-```
-
-## Controls
-| Key                  | Action                                  |
-| -------------------- | --------------------------------------- |
-| `+` / `-`            | Zoom in / out                           |
-| Arrow keys or `WASD` | Pan                                     |
-| `C` / `V`            | Increase / decrease contrast            |
-| `G` / `H`            | Increase / decrease gamma               |
-| `M`                  | Toggle colormap (`viridis` ↔ `magma`)   |
-| `[` / `]`            | Previous / next band (single-band only) |
-| `R`                  | Reset view                              |
-
-## Features
-- Command-line driven GeoTIFF viewer
-- Supports single-band or RGB composite display.
-- Optional shapefile overlay for geographic context.
-- Adjustable contrast, gamma, and colormap.
-- Fast preview using rasterio and PySide6.
-
-## Example Data
-- ECOSTRESS_LST.tif
-- Zip_Codes.shp and associated files
-- HLS_B04.tif, HLS_B03.tif, HLS_B02.tif (RGB sample)
-
-## Credit & License
-`viewtif` was inspired by the NASA JPL Thermal Viewer — Semi-Automated Georeferencer (GeoViewer v1.12) developed by Jake Longenecker (University of Miami Rosenstiel School of Marine, Atmospheric & Earth Science) while at the NASA Jet Propulsion Laboratory, California Institute of Technology, with inspiration from JPL’s ECOSTRESS geolocation batch workflow by Andrew Alamillo. The original GeoViewer was released under the MIT License (2025) and may be freely adapted with citation.
-
-# Citation
-Longenecker, Jake; Lee, Christine; Hulley, Glynn; Cawse-Nicholson, Kerry; Purkis, Sam; Gleason, Art; Otis, Dan; Galdamez,Ileana; Meiseles, Jacquelyn. GeoViewer v1.12: NASA JPL Thermal Viewer—Semi-Automated Georeferencer User Guide & Reference Manual. Jet Propulsion Laboratory, California Institute of Technology, 2025. PDF.
-
-# License
-This project is released under the MIT License.
-
-## Contributors
-- [@HarshShinde0](https://github.com/HarshShinde0) — added mouse-wheel and trackpad zoom support
-