ncftools 0.4.0__tar.gz → 0.5.2__tar.gz

{ncftools-0.4.0 → ncftools-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ncftools
-Version: 0.4.0
+Version: 0.5.2
 Summary: A collection of tools for working with NetCDF files
 Author-email: aaronchh <aaronhsu219@gmail.com>
 License-Expression: MIT
@@ -11,6 +11,8 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: numpy>=1.20.0
 Requires-Dist: netCDF4>=1.6.0
+Requires-Dist: geopandas>=0.12.0
+Requires-Dist: shapely>=1.8.0
 
 # NCFTOOLS
 
@@ -31,6 +33,9 @@ pip install -e .
 ### Command-line
 
 ```bash
+# Check installed version
+meshinfo --version
+
 # List all available commands
 ncftools-info
 

{ncftools-0.4.0 → ncftools-0.5.2}/README.md

@@ -17,6 +17,9 @@ pip install -e .
 ### Command-line
 
 ```bash
+# Check installed version
+meshinfo --version
+
 # List all available commands
 ncftools-info
 

{ncftools-0.4.0 → ncftools-0.5.2}/ncftools/__init__.py

@@ -2,13 +2,15 @@
 NCFTOOLS - A collection of tools for working with NetCDF files.
 """
 
-__version__ = '0.4.0'
+__version__ = '0.5.2'
 
 __all__ = [
     'meshinfo',
+    'nc2shp',
     'describe',
 ]
 
 from . import meshinfo
+from . import nc2shp
 from . import describe
 from . import cli

{ncftools-0.4.0 → ncftools-0.5.2}/ncftools/describe.py

@@ -18,6 +18,18 @@ TOOL_DESCRIPTIONS = {
             meshinfo -i FlowFM_net.nc    # Display mesh info for a given file
             meshinfo -i grid.nc          # Any FlowFM mesh NetCDF file
     """,
+    'nc2shp': """
+        Convert a NetCDF mesh file to ESRI Shapefiles.
+
+        Reads a UGRID-compliant NetCDF mesh file and writes two shapefiles:
+          {stem}_faces.shp      one polygon per mesh face
+          {stem}_dissolved.shp  single dissolved polygon of the entire mesh
+
+        Examples:
+            nc2shp -i FlowFM_net.nc
+            nc2shp -i mesh.nc -o output --crs EPSG:4326
+            nc2shp -i mesh.nc -q
+    """,
 }
 
 

ncftools-0.5.2/ncftools/nc2shp.py

@@ -0,0 +1,274 @@
+#!/usr/bin/env python3
+"""
+nc2shp - Convert NetCDF mesh faces to ESRI Shapefiles
+
+Reads a UGRID-compliant NetCDF mesh file and writes two shapefiles:
+  {stem}_faces.shp      - one polygon per mesh face
+  {stem}_dissolved.shp  - single dissolved polygon of the entire mesh
+"""
+
+import argparse
+import importlib.metadata
+import os
+import sys
+
+import netCDF4 as nc
+import numpy as np
+import geopandas as gpd
+from shapely.geometry import Polygon
+from shapely.ops import unary_union
+
+
+def read_mesh_netcdf(file_path, quiet=False):
+    """
+    Read mesh face coordinates from a UGRID NetCDF file.
+
+    Returns:
+        tuple: (face_x_coords, face_y_coords, node_x, node_y, face_nodes, var_names)
+    """
+    _print(f"Reading NetCDF file: {file_path}", quiet)
+
+    dataset = nc.Dataset(file_path, 'r')
+
+    var_names = {}
+    for var_name in dataset.variables:
+        vl = var_name.lower()
+        if 'node_x' in vl:
+            var_names['node_x'] = var_name
+        elif 'node_y' in vl:
+            var_names['node_y'] = var_name
+        elif 'face_nodes' in vl:
+            var_names['face_nodes'] = var_name
+        elif 'face_x_bnd' in vl:
+            var_names['face_x_bnd'] = var_name
+        elif 'face_y_bnd' in vl:
+            var_names['face_y_bnd'] = var_name
+
+    required = ['node_x', 'node_y', 'face_nodes', 'face_x_bnd', 'face_y_bnd']
+    missing = [v for v in required if v not in var_names]
+    if missing:
+        dataset.close()
+        raise ValueError(
+            f"Missing required variables: {missing}. "
+            f"Available: {list(dataset.variables.keys())}"
+        )
+
+    node_x = dataset.variables[var_names['node_x']][:]
+    node_y = dataset.variables[var_names['node_y']][:]
+    face_nodes = dataset.variables[var_names['face_nodes']][:]
+    face_x = dataset.variables[var_names['face_x_bnd']][:]
+    face_y = dataset.variables[var_names['face_y_bnd']][:]
+    dataset.close()
+
+    if not quiet:
+        print(f"  Nodes: {len(node_x):,}  Faces: {len(face_x):,}  "
+              f"Max nodes/face: {face_x.shape[1]}")
+
+    return face_x, face_y, node_x, node_y, face_nodes, var_names
+
+
+def create_polygons(face_x, face_y, quiet=False):
+    """
+    Build Shapely Polygon objects from mesh face coordinate arrays.
+
+    Returns:
+        list[Polygon]
+    """
+    _print("Creating polygons from mesh faces...", quiet)
+
+    polygons = []
+    n_invalid = 0
+    tri = quad = 0
+
+    for i in range(len(face_x)):
+        coords = [
+            (float(face_x[i, j]), float(face_y[i, j]))
+            for j in range(face_x.shape[1])
+            if (not np.ma.is_masked(face_x[i, j])
+                and not np.ma.is_masked(face_y[i, j])
+                and abs(face_x[i, j]) < 1e30
+                and abs(face_y[i, j]) < 1e30)
+        ]
+
+        if len(coords) < 3:
+            n_invalid += 1
+            continue
+
+        if coords[0] != coords[-1]:
+            coords.append(coords[0])
+
+        try:
+            poly = Polygon(coords)
+            if not poly.is_valid or poly.is_empty:
+                poly = poly.buffer(0)
+            if poly.is_valid and not poly.is_empty:
+                polygons.append(poly)
+                n = len(coords) - 1  # exclude closing duplicate
+                if n == 3:
+                    tri += 1
+                elif n == 4:
+                    quad += 1
+            else:
+                n_invalid += 1
+        except Exception as e:
+            n_invalid += 1
+            if not quiet:
+                print(f"  Warning: face {i} skipped: {e}")
+
+    if not quiet:
+        print(f"  Valid polygons: {len(polygons)}  "
+              f"(triangles: {tri}, quads: {quad}, skipped: {n_invalid})")
+
+    return polygons
+
+
+def create_geodataframe(polygons, crs="EPSG:3826"):
+    """Build a GeoDataFrame from a list of Shapely polygons."""
+    data = {
+        'face_id': range(len(polygons)),
+        'area': [p.area for p in polygons],
+        'type': [
+            'triangle' if len(list(p.exterior.coords)) == 4
+            else 'quadrilateral' if len(list(p.exterior.coords)) == 5
+            else 'other'
+            for p in polygons
+        ],
+    }
+    return gpd.GeoDataFrame(data, geometry=polygons, crs=crs)
+
+
+def dissolve_geodataframe(gdf, quiet=False):
+    """Dissolve all polygons into a single geometry."""
+    _print("Dissolving polygons...", quiet)
+    geom = unary_union(gdf.geometry.tolist())
+    dissolved = gpd.GeoDataFrame(
+        {'id': [1], 'total_area': [geom.area], 'count': [len(gdf)]},
+        geometry=[geom],
+        crs=gdf.crs,
+    )
+    _print(f"  Total area: {geom.area:.2f} sq units", quiet)
+    return dissolved
+
+
+def mesh_to_shp(input_file, output_dir="SHP_NC", crs="EPSG:3826", quiet=False):
+    """
+    Convert a NetCDF mesh file to face and dissolved shapefiles.
+
+    Args:
+        input_file (str): Path to the input NetCDF file.
+        output_dir (str): Directory for output shapefiles.
+        crs (str): CRS for output shapefiles.
+        quiet (bool): Suppress non-error output.
+
+    Returns:
+        tuple[str, str]: Paths to (faces_shp, dissolved_shp).
+    """
+    _print("=== NetCDF Mesh to Shapefile Converter ===", quiet)
+
+    os.makedirs(output_dir, exist_ok=True)
+    stem = os.path.splitext(os.path.basename(input_file))[0]
+    out_faces = os.path.join(output_dir, f"{stem}_faces.shp")
+    out_dissolved = os.path.join(output_dir, f"{stem}_dissolved.shp")
+
+    face_x, face_y, node_x, node_y, face_nodes, var_names = read_mesh_netcdf(
+        input_file, quiet
+    )
+    polygons = create_polygons(face_x, face_y, quiet)
+
+    if not polygons:
+        raise RuntimeError("No valid polygons were created from the mesh.")
+
+    gdf = create_geodataframe(polygons, crs)
+    _print(f"Saving faces shapefile:    {out_faces}", quiet)
+    gdf.to_file(out_faces)
+
+    dissolved = dissolve_geodataframe(gdf, quiet)
+    _print(f"Saving dissolved shapefile: {out_dissolved}", quiet)
+    dissolved.to_file(out_dissolved)
+
+    if not quiet:
+        bounds = gdf.total_bounds
+        counts = gdf['type'].value_counts()
+        print("\n=== SUMMARY ===")
+        print(f"  Input:     {input_file}")
+        print(f"  Faces:     {out_faces}")
+        print(f"  Dissolved: {out_dissolved}")
+        print(f"  Faces processed: {len(face_x):,}  Valid: {len(polygons):,}")
+        print(f"  CRS: {gdf.crs}")
+        for t, n in counts.items():
+            print(f"  {t}: {n} ({n/len(gdf)*100:.1f}%)")
+        print(f"  Area — min: {gdf.geometry.area.min():.2f}  "
+              f"max: {gdf.geometry.area.max():.2f}  "
+              f"mean: {gdf.geometry.area.mean():.2f}")
+        print(f"  X: {bounds[0]:.2f} to {bounds[2]:.2f}")
+        print(f"  Y: {bounds[1]:.2f} to {bounds[3]:.2f}")
+
+    return out_faces, out_dissolved
+
+
+def _print(msg, quiet=False):
+    if not quiet:
+        print(msg)
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog='nc2shp',
+        description='Convert a NetCDF mesh file to ESRI Shapefiles',
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""
+Examples:
+  nc2shp -i FlowFM_net.nc
+  nc2shp -i mesh.nc -o output --crs EPSG:4326
+  nc2shp -i mesh.nc -q
+        """,
+    )
+
+    parser.add_argument(
+        '-v', '--version',
+        action='version',
+        version=f'%(prog)s {importlib.metadata.version("ncftools")}',
+    )
+    parser.add_argument(
+        '-i', '--input',
+        required=True,
+        metavar='FILE',
+        help='Path to the NetCDF mesh file',
+    )
+    parser.add_argument(
+        '-o', '--output-dir',
+        default='SHP_NC',
+        metavar='DIR',
+        help='Output directory for shapefiles (default: SHP_NC)',
+    )
+    parser.add_argument(
+        '--crs',
+        default='EPSG:3826',
+        help='Coordinate reference system (default: EPSG:3826)',
+    )
+    parser.add_argument(
+        '-q', '--quiet',
+        action='store_true',
+        help='Suppress non-error output',
+    )
+
+    args = parser.parse_args()
+
+    if not os.path.isfile(args.input):
+        print(f"Error: File '{args.input}' not found.", file=sys.stderr)
+        sys.exit(1)
+
+    try:
+        faces, dissolved = mesh_to_shp(
+            args.input, args.output_dir, args.crs, args.quiet
+        )
+        if args.quiet:
+            print(faces)
+            print(dissolved)
+    except Exception as e:
+        print(f"Error: {e}", file=sys.stderr)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

{ncftools-0.4.0 → ncftools-0.5.2}/ncftools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ncftools
-Version: 0.4.0
+Version: 0.5.2
 Summary: A collection of tools for working with NetCDF files
 Author-email: aaronchh <aaronhsu219@gmail.com>
 License-Expression: MIT
@@ -11,6 +11,8 @@ Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: numpy>=1.20.0
 Requires-Dist: netCDF4>=1.6.0
+Requires-Dist: geopandas>=0.12.0
+Requires-Dist: shapely>=1.8.0
 
 # NCFTOOLS
 
@@ -31,6 +33,9 @@ pip install -e .
 ### Command-line
 
 ```bash
+# Check installed version
+meshinfo --version
+
 # List all available commands
 ncftools-info
 

{ncftools-0.4.0 → ncftools-0.5.2}/ncftools.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ ncftools/__init__.py
 ncftools/cli.py
 ncftools/describe.py
 ncftools/meshinfo.py
+ncftools/nc2shp.py
 ncftools.egg-info/PKG-INFO
 ncftools.egg-info/SOURCES.txt
 ncftools.egg-info/dependency_links.txt

{ncftools-0.4.0 → ncftools-0.5.2}/ncftools.egg-info/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
 meshinfo = ncftools.meshinfo:main
+nc2shp = ncftools.nc2shp:main
 ncftools = ncftools.cli:main
 ncftools-info = ncftools.describe:main

ncftools-0.5.2/ncftools.egg-info/requires.txt

@@ -0,0 +1,4 @@
+numpy>=1.20.0
+netCDF4>=1.6.0
+geopandas>=0.12.0
+shapely>=1.8.0

{ncftools-0.4.0 → ncftools-0.5.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ncftools"
-version = "0.4.0"
+version = "0.5.2"
 authors = [
     { name = "aaronchh", email = "aaronhsu219@gmail.com" },
 ]
@@ -15,6 +15,8 @@ requires-python = ">=3.8"
 dependencies = [
     "numpy>=1.20.0",
     "netCDF4>=1.6.0",
+    "geopandas>=0.12.0",
+    "shapely>=1.8.0",
 ]
 classifiers = [
     "Programming Language :: Python :: 3",
@@ -31,3 +33,4 @@ Homepage = "https://github.com/AaronOET/ncftools"
 ncftools-info = "ncftools.describe:main"
 ncftools = "ncftools.cli:main"
 meshinfo = "ncftools.meshinfo:main"
+nc2shp = "ncftools.nc2shp:main"

ncftools-0.4.0/ncftools.egg-info/requires.txt

@@ -1,2 +0,0 @@
-numpy>=1.20.0
-netCDF4>=1.6.0