ncftools 0.1.0__py3-none-any.whl

ncftools/__init__.py

@@ -0,0 +1,14 @@
+"""
+NCFTOOLS - A collection of tools for working with NetCDF files.
+"""
+
+__version__ = '0.1.0'
+
+__all__ = [
+    'meshinfo',
+    'describe',
+]
+
+from . import meshinfo
+from . import describe
+from . import cli

ncftools/cli.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+"""
+Top-level `ncftools` command. Running `ncftools -h` (or with no arguments)
+prints the same information shown by `ncftools-info`.
+"""
+
+import sys
+
+from . import describe
+
+
+def _print_info(tool=None):
+    argv_backup = sys.argv
+    try:
+        sys.argv = ['ncftools-info'] + ([tool] if tool else [])
+        describe.main()
+    finally:
+        sys.argv = argv_backup
+
+
+def main():
+    args = sys.argv[1:]
+
+    if not args or args[0] in ('-h', '--help'):
+        _print_info()
+        return
+
+    tool = args[0]
+    if tool in describe.TOOL_DESCRIPTIONS:
+        _print_info(tool)
+        return
+
+    print(f"Unknown option or tool: {tool}", file=sys.stderr)
+    print("Run 'ncftools -h' to see available tools.", file=sys.stderr)
+    sys.exit(2)
+
+
+if __name__ == "__main__":
+    main()

ncftools/describe.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python
+"""
+Command-line utility to display descriptions of ncftools functionality.
+"""
+
+import argparse
+from textwrap import dedent
+
+TOOL_DESCRIPTIONS = {
+    'meshinfo': """
+        Display mesh information from FlowFM NetCDF files.
+
+        This tool reads a FlowFM NetCDF mesh file and reports the number of
+        nodes, faces, and edges, element type distribution (triangles vs
+        quadrilaterals), and the spatial extent of the mesh.
+
+        Examples:
+            meshinfo -f FlowFM_net.nc    # Display mesh info for a given file
+            meshinfo -f grid.nc          # Any FlowFM mesh NetCDF file
+    """,
+}
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog='ncftools-info',
+        description='Display descriptions of ncftools commands',
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument(
+        'tool',
+        nargs='?',
+        choices=list(TOOL_DESCRIPTIONS.keys()),
+        help='Tool name to describe (omit to list all tools)',
+    )
+    args = parser.parse_args()
+
+    if args.tool:
+        print(f"\n--- {args.tool} ---")
+        print(dedent(TOOL_DESCRIPTIONS[args.tool]))
+    else:
+        print("\nNCFTOOLS — NetCDF utility commands\n")
+        for tool, desc in TOOL_DESCRIPTIONS.items():
+            first_line = dedent(desc).strip().splitlines()[0]
+            print(f"  {tool:<14} {first_line}")
+        print("\nRun 'ncftools-info <tool>' for details on a specific command.")
+
+
+if __name__ == "__main__":
+    main()

ncftools/meshinfo.py

@@ -0,0 +1,100 @@
+#!/usr/bin/env python3
+"""
+meshinfo - Display mesh information from FlowFM NetCDF files
+Uses netCDF4 Python bindings
+"""
+
+import argparse
+import os
+import sys
+
+import netCDF4 as nc
+import numpy as np
+
+
+def show_mesh_info(nc_file):
+    """
+    Display mesh information from a FlowFM NetCDF file.
+
+    Args:
+        nc_file (str): Path to the FlowFM NetCDF mesh file
+    """
+    dataset = nc.Dataset(nc_file, 'r')
+
+    print(f"FlowFM Mesh Information from: {nc_file}")
+    print("=" * 60)
+
+    nodes = dataset.dimensions['Mesh2d_nNodes'].size
+    faces = dataset.dimensions['Mesh2d_nFaces'].size
+    edges = dataset.dimensions['Mesh2d_nEdges'].size
+
+    print(f"Number of mesh nodes:     {nodes:,}")
+    print(f"Number of mesh faces:     {faces:,}")
+    print(f"Number of mesh edges:     {edges:,}")
+
+    if 'Mesh2d_face_nodes' in dataset.variables:
+        face_nodes = dataset.variables['Mesh2d_face_nodes'][:]
+        fill_value = dataset.variables['Mesh2d_face_nodes']._FillValue
+        valid_nodes = np.sum(face_nodes != fill_value, axis=1)
+
+        triangles = int(np.sum(valid_nodes == 3))
+        quads = int(np.sum(valid_nodes == 4))
+
+        print("\nElement Types:")
+        print(f"  Triangular elements:    {triangles:,}")
+        print(f"  Quadrilateral elements: {quads:,}")
+        print(f"  Total elements:         {triangles + quads:,}")
+
+    if 'Mesh2d_node_x' in dataset.variables and 'Mesh2d_node_y' in dataset.variables:
+        x_coords = dataset.variables['Mesh2d_node_x'][:]
+        y_coords = dataset.variables['Mesh2d_node_y'][:]
+
+        print("\nSpatial extent:")
+        print(f"  X range: {np.min(x_coords):.1f} to {np.max(x_coords):.1f}")
+        print(f"  Y range: {np.min(y_coords):.1f} to {np.max(y_coords):.1f}")
+
+    dataset.close()
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog='meshinfo',
+        description='Display mesh information from FlowFM NetCDF files',
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""
+Examples:
+  meshinfo -f FlowFM_net.nc        # Specify a NetCDF mesh file
+  meshinfo -f grid.nc              # Use any FlowFM mesh file
+  meshinfo -h                      # Show this help message
+
+The tool displays:
+  - Number of nodes, faces, and edges
+  - Element type distribution (triangles vs quadrilaterals)
+  - Spatial extent (X and Y coordinate ranges)
+        """,
+    )
+
+    parser.add_argument(
+        '-f', '--file',
+        required=True,
+        metavar='FILE',
+        help='Path to the FlowFM NetCDF mesh file',
+    )
+
+    args = parser.parse_args()
+
+    if not os.path.isfile(args.file):
+        print(f"Error: File '{args.file}' not found.")
+        print(f"Current directory: {os.getcwd()}")
+        print("Please check the file path and try again.")
+        sys.exit(1)
+
+    try:
+        show_mesh_info(args.file)
+    except Exception as e:
+        print(f"Error reading NetCDF file: {e}")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

ncftools-0.1.0.dist-info/METADATA

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: ncftools
+Version: 0.1.0
+Summary: A collection of tools for working with NetCDF files
+Author-email: aaronchh <aaronhsu219@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/AaronOET/ncftools
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: numpy>=1.20.0
+Requires-Dist: netCDF4>=1.6.0
+
+# NCFTOOLS
+
+A collection of Python tools for working with NetCDF files.
+
+## Installation
+
+```bash
+pip install -e .
+```
+
+## Features
+
+- **meshinfo**: Display mesh information from FlowFM NetCDF files (node/face/edge counts, element types, spatial extent)
+
+## Usage
+
+### Command-line
+
+```bash
+# List all available commands
+ncftools-info
+
+# Display mesh information from a FlowFM NetCDF file
+meshinfo -f FlowFM_net.nc
+
+# Show help for meshinfo
+meshinfo -h
+```
+
+### Python API
+
+```python
+from ncftools import meshinfo
+
+# Display mesh info for a NetCDF file
+meshinfo.show_mesh_info("FlowFM_net.nc")
+```

ncftools-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+ncftools/__init__.py,sha256=A9QHKf1UA0ePNgIUariJsNhMUF3HGI2T-B7_BYw7RhU,207
+ncftools/cli.py,sha256=N-LecSrDURy_uvQFh57upvoWRIYprhTrvAj07rw1gGQ,812
+ncftools/describe.py,sha256=CW89EKkPq0jgTpoFuQxB6zlO46QM-x0nnsD6YYclfVM,1525
+ncftools/meshinfo.py,sha256=rFDEJs2JPLvAITm8wjh1jz2_DSpFbVXHwS31aGykAfw,2971
+ncftools/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ncftools-0.1.0.dist-info/METADATA,sha256=lLEHjBTBk67Nt4x7CHEPUZ7xJpf4Tarwbj7StszNhGw,1060
+ncftools-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+ncftools-0.1.0.dist-info/entry_points.txt,sha256=ATHDbWTGOKdeTtcHgUICDVutpypAzmvXoISCtshb8-M,120
+ncftools-0.1.0.dist-info/top_level.txt,sha256=sQF2Q9jJGb5XXwiun5tmyk_5O3Rd0U4AGzSsdAMcyrc,9
+ncftools-0.1.0.dist-info/RECORD,,

ncftools-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

ncftools-0.1.0.dist-info/entry_points.txt

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

ncftools-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+ncftools