ncftools 0.6.2__tar.gz → 0.9.0__tar.gz

{ncftools-0.6.2 → ncftools-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ncftools
-Version: 0.6.2
+Version: 0.9.0
 Summary: A collection of tools for working with NetCDF files
 Author-email: aaronchh <aaronhsu219@gmail.com>
 License-Expression: MIT
@@ -30,6 +30,8 @@ pip install -e .
 - **nc2shp**: Convert a UGRID-compliant NetCDF mesh file to ESRI Shapefiles
 - **transzone1**: Build a transition zone from triangle mesh faces and select all intersecting faces
 - **transzone2**: Extract the core transition zone — faces fully within the shrunk zone
+- **setncrain**: Point a D-Flow FM model (`.ext` / `.mdu`) at a NetCDF rainfall forcing file
+- **rnxml**: Rename `dimr.xml` to `dimr_config.xml`
 
 ## Usage
 
@@ -56,10 +58,13 @@ meshinfo -h
 
 ### nc2shp
 
-Convert a NetCDF mesh file to ESRI Shapefiles. Outputs `{stem}_faces.shp` and `{stem}_dissolved.shp` in the output directory.
+Convert a NetCDF mesh file to ESRI Shapefiles. Outputs `{stem}_faces.shp` in the output
+directory. Pass `-d`/`--dissolve` to additionally write `{stem}_dissolved.shp`, a single
+polygon dissolved from all mesh faces (slower on large meshes).
 
 ```bash
 nc2shp -i FlowFM_net.nc
+nc2shp -i mesh.nc -d
 nc2shp -i mesh.nc -o output --crs EPSG:4326
 nc2shp -i mesh.nc -q
 ```
@@ -89,6 +94,51 @@ transzone2 -i SHP_NC/FlowFM_net_faces.shp -z SHP_TRANS/trans_zone_extend.shp -o
 transzone2 -i SHP_NC/FlowFM_net_faces.shp -z SHP_TRANS/trans_zone_extend.shp -q
 ```
 
+### setncrain
+
+Point a D-Flow FM model at a NetCDF rainfall forcing file.
+
+Every `[Meteo]` block in the `.ext` file is rewritten to
+`quantity=rainfall`, `forcingFile=<your .nc>`, `forcingFileType=netcdf`.
+If the `.ext` file does not exist it is created from a built-in template and
+registered in the `.mdu` as `ExtForceFileNew`.
+
+The NetCDF time axis is read and the model times in the `.mdu` are set to match it
+(expressed in the model's `Tunit`):
+
+| Key | Value |
+| --- | --- |
+| `RefDate` | midnight of the first time stamp |
+| `TStart` | offset of the first time stamp from `RefDate` |
+| `TStop` | offset of the last time stamp from `RefDate` |
+
+The `forcingFile` path is written relative to the `.ext` file (D-Flow FM resolves it
+that way); use `--as-given` to write it exactly as typed. `.bak` copies of the
+modified files are written unless `--no-backup` is given.
+
+```bash
+setncrain -i May28_Event.nc
+setncrain -i data/May28_Event.nc --ext dflowfm/FM_model_bnd.ext
+setncrain -i May28_Event.nc --mdu dflowfm/FM_model.mdu --no-time
+setncrain -i May28_Event.nc --no-backup --as-given
+setncrain -i May28_Event.nc -q
+```
+
+### rnxml
+
+Rename `dimr.xml` to `dimr_config.xml`, the name the DIMR runner expects. The file
+stays in its folder and its contents are not touched.
+
+If `dimr_config.xml` already exists the rename is refused; pass `--force` to
+overwrite it (a `.bak` copy of the old target is kept unless `--no-backup`).
+
+```bash
+rnxml
+rnxml -i model/dimr.xml
+rnxml -i dimr.xml -o dimr_config.xml --force
+rnxml -i dimr.xml -q
+```
+
 ## Python API
 
 ```python

{ncftools-0.6.2 → ncftools-0.9.0}/README.md

@@ -14,6 +14,8 @@ pip install -e .
 - **nc2shp**: Convert a UGRID-compliant NetCDF mesh file to ESRI Shapefiles
 - **transzone1**: Build a transition zone from triangle mesh faces and select all intersecting faces
 - **transzone2**: Extract the core transition zone — faces fully within the shrunk zone
+- **setncrain**: Point a D-Flow FM model (`.ext` / `.mdu`) at a NetCDF rainfall forcing file
+- **rnxml**: Rename `dimr.xml` to `dimr_config.xml`
 
 ## Usage
 
@@ -40,10 +42,13 @@ meshinfo -h
 
 ### nc2shp
 
-Convert a NetCDF mesh file to ESRI Shapefiles. Outputs `{stem}_faces.shp` and `{stem}_dissolved.shp` in the output directory.
+Convert a NetCDF mesh file to ESRI Shapefiles. Outputs `{stem}_faces.shp` in the output
+directory. Pass `-d`/`--dissolve` to additionally write `{stem}_dissolved.shp`, a single
+polygon dissolved from all mesh faces (slower on large meshes).
 
 ```bash
 nc2shp -i FlowFM_net.nc
+nc2shp -i mesh.nc -d
 nc2shp -i mesh.nc -o output --crs EPSG:4326
 nc2shp -i mesh.nc -q
 ```
@@ -73,6 +78,51 @@ transzone2 -i SHP_NC/FlowFM_net_faces.shp -z SHP_TRANS/trans_zone_extend.shp -o
 transzone2 -i SHP_NC/FlowFM_net_faces.shp -z SHP_TRANS/trans_zone_extend.shp -q
 ```
 
+### setncrain
+
+Point a D-Flow FM model at a NetCDF rainfall forcing file.
+
+Every `[Meteo]` block in the `.ext` file is rewritten to
+`quantity=rainfall`, `forcingFile=<your .nc>`, `forcingFileType=netcdf`.
+If the `.ext` file does not exist it is created from a built-in template and
+registered in the `.mdu` as `ExtForceFileNew`.
+
+The NetCDF time axis is read and the model times in the `.mdu` are set to match it
+(expressed in the model's `Tunit`):
+
+| Key | Value |
+| --- | --- |
+| `RefDate` | midnight of the first time stamp |
+| `TStart` | offset of the first time stamp from `RefDate` |
+| `TStop` | offset of the last time stamp from `RefDate` |
+
+The `forcingFile` path is written relative to the `.ext` file (D-Flow FM resolves it
+that way); use `--as-given` to write it exactly as typed. `.bak` copies of the
+modified files are written unless `--no-backup` is given.
+
+```bash
+setncrain -i May28_Event.nc
+setncrain -i data/May28_Event.nc --ext dflowfm/FM_model_bnd.ext
+setncrain -i May28_Event.nc --mdu dflowfm/FM_model.mdu --no-time
+setncrain -i May28_Event.nc --no-backup --as-given
+setncrain -i May28_Event.nc -q
+```
+
+### rnxml
+
+Rename `dimr.xml` to `dimr_config.xml`, the name the DIMR runner expects. The file
+stays in its folder and its contents are not touched.
+
+If `dimr_config.xml` already exists the rename is refused; pass `--force` to
+overwrite it (a `.bak` copy of the old target is kept unless `--no-backup`).
+
+```bash
+rnxml
+rnxml -i model/dimr.xml
+rnxml -i dimr.xml -o dimr_config.xml --force
+rnxml -i dimr.xml -q
+```
+
 ## Python API
 
 ```python

{ncftools-0.6.2 → ncftools-0.9.0}/ncftools/__init__.py

@@ -2,13 +2,15 @@
 NCFTOOLS - A collection of tools for working with NetCDF files.
 """
 
-__version__ = '0.6.2'
+__version__ = '0.9.0'
 
 __all__ = [
     'meshinfo',
     'nc2shp',
     'transzone1',
     'transzone2',
+    'setncrain',
+    'rnxml',
     'describe',
 ]
 
@@ -16,5 +18,7 @@ from . import meshinfo
 from . import nc2shp
 from . import transzone1
 from . import transzone2
+from . import setncrain
+from . import rnxml
 from . import describe
 from . import cli

{ncftools-0.6.2 → ncftools-0.9.0}/ncftools/describe.py

@@ -21,12 +21,14 @@ TOOL_DESCRIPTIONS = {
     'nc2shp': """
         Convert a NetCDF mesh file to ESRI Shapefiles.
 
-        Reads a UGRID-compliant NetCDF mesh file and writes two shapefiles:
+        Reads a UGRID-compliant NetCDF mesh file and writes:
           {stem}_faces.shp      one polygon per mesh face
           {stem}_dissolved.shp  single dissolved polygon of the entire mesh
+                                (only written with -d/--dissolve)
 
         Examples:
             nc2shp -i FlowFM_net.nc
+            nc2shp -i mesh.nc -d          # also write the dissolved polygon
             nc2shp -i mesh.nc -o output --crs EPSG:4326
             nc2shp -i mesh.nc -q
     """,
@@ -58,6 +60,43 @@ TOOL_DESCRIPTIONS = {
             transzone2 -i SHP_NC/FlowFM_net_faces.shp -z SHP_TRANS/trans_zone_faces.shp -o SHP_TRANS
             transzone2 -i SHP_NC/FlowFM_net_faces.shp -z SHP_TRANS/trans_zone_faces.shp -q
     """,
+    'setncrain': """
+        Point a D-Flow FM model at a NetCDF rainfall forcing file.
+
+        Rewrites every [Meteo] block of the .ext file to use the given NetCDF
+        file as rainfall forcing:
+          quantity=rainfall, forcingFile=<*.nc>, forcingFileType=netcdf
+        If the .ext file is missing it is created from a built-in template and
+        registered in the .mdu as ExtForceFileNew.
+
+        The NetCDF time axis is read and the model times in the .mdu are set
+        to match it (in the model's Tunit):
+          RefDate  midnight of the first time stamp
+          TStart   offset of the first time stamp from RefDate
+          TStop    offset of the last  time stamp from RefDate
+
+        Examples:
+            setncrain -i May28_Event.nc
+            setncrain -i data/May28_Event.nc --ext dflowfm/FM_model_bnd.ext
+            setncrain -i May28_Event.nc --no-time
+            setncrain -i May28_Event.nc --no-backup --as-given
+    """,
+    'rnxml': """
+        Rename dimr.xml to dimr_config.xml.
+
+        D-HYDRO / Delft3D FM writes its DIMR control file as dimr.xml, while
+        the DIMR runner expects dimr_config.xml. This tool renames the file in
+        place, leaving its contents untouched.
+
+        If the target name already exists the rename is refused unless --force
+        is given, in which case a .bak copy of the old target is kept.
+
+        Examples:
+            rnxml
+            rnxml -i model/dimr.xml
+            rnxml -i dimr.xml -o dimr_config.xml --force
+            rnxml -i dimr.xml -q
+    """,
 }
 
 

{ncftools-0.6.2 → ncftools-0.9.0}/ncftools/nc2shp.py

@@ -2,9 +2,10 @@
 """
 nc2shp - Convert NetCDF mesh faces to ESRI Shapefiles
 
-Reads a UGRID-compliant NetCDF mesh file and writes two shapefiles:
+Reads a UGRID-compliant NetCDF mesh file and writes:
   {stem}_faces.shp      - one polygon per mesh face
   {stem}_dissolved.shp  - single dissolved polygon of the entire mesh
+                          (only with --dissolve)
 """
 
 import argparse
@@ -149,25 +150,30 @@ def dissolve_geodataframe(gdf, quiet=False):
     return dissolved
 
 
-def mesh_to_shp(input_file, output_dir="SHP_NC", crs="EPSG:3826", quiet=False):
+def mesh_to_shp(input_file, output_dir="SHP_NC", crs="EPSG:3826", quiet=False,
+                dissolve=False):
     """
-    Convert a NetCDF mesh file to face and dissolved shapefiles.
+    Convert a NetCDF mesh file to face and (optionally) 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.
+        dissolve (bool): Also write a single dissolved polygon shapefile.
 
     Returns:
-        tuple[str, str]: Paths to (faces_shp, dissolved_shp).
+        tuple[str, str | None]: Paths to (faces_shp, dissolved_shp). The second
+        element is None when dissolve is False.
     """
     _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")
+    out_dissolved = (
+        os.path.join(output_dir, f"{stem}_dissolved.shp") if dissolve else None
+    )
 
     face_x, face_y, node_x, node_y, face_nodes, var_names = read_mesh_netcdf(
         input_file, quiet
@@ -181,9 +187,10 @@ def mesh_to_shp(input_file, output_dir="SHP_NC", crs="EPSG:3826", quiet=False):
     _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 dissolve:
+        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
@@ -191,7 +198,8 @@ def mesh_to_shp(input_file, output_dir="SHP_NC", crs="EPSG:3826", quiet=False):
         print("\n=== SUMMARY ===")
         print(f"  Input:     {input_file}")
         print(f"  Faces:     {out_faces}")
-        print(f"  Dissolved: {out_dissolved}")
+        if dissolve:
+            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():
@@ -218,6 +226,7 @@ def main():
         epilog="""
 Examples:
   nc2shp -i FlowFM_net.nc
+  nc2shp -i mesh.nc -d
   nc2shp -i mesh.nc -o output --crs EPSG:4326
   nc2shp -i mesh.nc -q
         """,
@@ -245,6 +254,12 @@ Examples:
         default='EPSG:3826',
         help='Coordinate reference system (default: EPSG:3826)',
     )
+    parser.add_argument(
+        '-d', '--dissolve',
+        action='store_true',
+        help='Also write {stem}_dissolved.shp, a single polygon dissolved '
+             'from all mesh faces (slower on large meshes)',
+    )
     parser.add_argument(
         '-q', '--quiet',
         action='store_true',
@@ -259,11 +274,12 @@ Examples:
 
     try:
         faces, dissolved = mesh_to_shp(
-            args.input, args.output_dir, args.crs, args.quiet
+            args.input, args.output_dir, args.crs, args.quiet, args.dissolve
         )
         if args.quiet:
             print(faces)
-            print(dissolved)
+            if dissolved:
+                print(dissolved)
     except Exception as e:
         print(f"Error: {e}", file=sys.stderr)
         sys.exit(1)

ncftools-0.9.0/ncftools/rnxml.py

@@ -0,0 +1,151 @@
+#!/usr/bin/env python3
+"""
+rnxml - Rename dimr.xml to dimr_config.xml
+
+D-HYDRO / Delft3D FM writes its DIMR control file as dimr.xml, while the DIMR
+runner expects dimr_config.xml. This tool renames the file in place.
+
+The file contents are not touched. If the target name already exists the
+rename is refused unless --force is given, in which case a .bak copy of the
+existing target is kept (unless --no-backup).
+"""
+
+import argparse
+import importlib.metadata
+import os
+import shutil
+import sys
+from pathlib import Path
+
+DEFAULT_INPUT = 'dimr.xml'
+DEFAULT_OUTPUT_NAME = 'dimr_config.xml'
+
+
+def _print(msg, quiet=False):
+    if not quiet:
+        print(msg)
+
+
+def rename_xml(
+    input_file=DEFAULT_INPUT,
+    output_name=DEFAULT_OUTPUT_NAME,
+    force=False,
+    backup=True,
+    quiet=False,
+):
+    """
+    Rename an XML file, keeping it in the same directory.
+
+    Args:
+        input_file (str): Path to the file to rename (default: dimr.xml).
+        output_name (str): New file name, without a directory part
+            (default: dimr_config.xml).
+        force (bool): Overwrite the target if it already exists.
+        backup (bool): When overwriting, keep a .bak copy of the old target.
+        quiet (bool): Suppress non-error output.
+
+    Returns:
+        Path: Path of the renamed file.
+
+    Raises:
+        FileNotFoundError: The input file does not exist.
+        ValueError: output_name contains a directory part.
+        FileExistsError: The target exists and force is False.
+    """
+    src = Path(input_file)
+    if not src.is_file():
+        raise FileNotFoundError(f"file not found: {src}")
+
+    if os.path.dirname(output_name):
+        raise ValueError(
+            f"--output-name must be a file name, not a path: {output_name}"
+        )
+
+    dst = src.parent / output_name
+
+    if src.resolve() == dst.resolve():
+        _print(f"{src} is already named {output_name} - nothing to do.", quiet)
+        return dst
+
+    if dst.exists():
+        if not force:
+            raise FileExistsError(
+                f"{dst} already exists - use --force to overwrite it"
+            )
+        if backup:
+            bak = dst.with_suffix(dst.suffix + '.bak')
+            shutil.copy2(dst, bak)
+            _print(f"Backup written: {bak}", quiet)
+
+    os.replace(src, dst)
+    _print(f"Renamed: {src} -> {dst}", quiet)
+    return dst
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog='rnxml',
+        description='Rename dimr.xml to dimr_config.xml',
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""
+Examples:
+  rnxml
+  rnxml -i dimr.xml
+  rnxml -i model/dimr.xml
+  rnxml -i dimr.xml -o dimr_config.xml --force
+  rnxml -i dimr.xml -q
+        """,
+    )
+
+    parser.add_argument(
+        '-v', '--version',
+        action='version',
+        version=f'%(prog)s {importlib.metadata.version("ncftools")}',
+    )
+    parser.add_argument(
+        '-i', '--input',
+        default=DEFAULT_INPUT,
+        metavar='FILE',
+        help=f'File to rename (default: {DEFAULT_INPUT})',
+    )
+    parser.add_argument(
+        '-o', '--output-name',
+        default=DEFAULT_OUTPUT_NAME,
+        metavar='NAME',
+        help=f'New file name, kept in the same folder (default: {DEFAULT_OUTPUT_NAME})',
+    )
+    parser.add_argument(
+        '--force',
+        action='store_true',
+        help='Overwrite the target file if it already exists',
+    )
+    parser.add_argument(
+        '--no-backup',
+        action='store_true',
+        help='Do not keep a .bak copy of an overwritten target',
+    )
+    parser.add_argument(
+        '-q', '--quiet',
+        action='store_true',
+        help='Suppress non-error output',
+    )
+
+    args = parser.parse_args()
+
+    try:
+        dst = rename_xml(
+            args.input,
+            output_name=args.output_name,
+            force=args.force,
+            backup=not args.no_backup,
+            quiet=args.quiet,
+        )
+        if args.quiet:
+            print(dst)
+    except Exception as e:
+        print(f"Error: {e}", file=sys.stderr)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

ncftools-0.9.0/ncftools/setncrain.py

@@ -0,0 +1,561 @@
+#!/usr/bin/env python3
+"""
+setncrain - Point a D-Flow FM model at a NetCDF rainfall forcing file
+
+In every [Meteo] block of the .ext file:
+    quantity        -> rainfall
+    forcingFile     -> <user specified *.nc>
+    forcingFileType -> netcdf
+
+If the .ext file does not exist it is created from the hard-coded TEMPLATE
+below, already pointing at the given NetCDF file, and ExtForceFileNew in the
+model definition file (*.mdu) is set to it.
+
+The NetCDF time axis is read and the model times in the .mdu are adjusted to it:
+    RefDate -> the date of the first time stamp (midnight)
+    TStart  -> offset of the first time stamp from RefDate (in Tunit)
+    TStop   -> offset of the last  time stamp from RefDate (in Tunit)
+"""
+
+import argparse
+import importlib.metadata
+import os
+import re
+import shutil
+import sys
+from datetime import datetime, timedelta
+from pathlib import Path
+from typing import Optional
+
+REPLACEMENTS = {
+    "quantity": "rainfall",
+    "forcingfiletype": "netcdf",
+    # forcingFile is filled in at runtime
+}
+
+# Hard-coded .ext contents, used when the .ext file is missing.
+# Edit here to change the generated file; {forcing_file} is substituted.
+TEMPLATE = """[General]
+fileVersion=2.02
+fileType=extForce
+
+[Meteo]
+quantity=rainfall
+forcingFile={forcing_file}
+forcingFileType=netcdf
+interpolationMethod=linearSpaceTime
+operand=O
+
+"""
+
+CF_UNITS = {
+    "second": 1.0, "seconds": 1.0, "sec": 1.0, "secs": 1.0, "s": 1.0,
+    "minute": 60.0, "minutes": 60.0, "min": 60.0, "mins": 60.0,
+    "hour": 3600.0, "hours": 3600.0, "hr": 3600.0, "hrs": 3600.0, "h": 3600.0,
+    "day": 86400.0, "days": 86400.0, "d": 86400.0,
+}
+# TStart/TStop are expressed in the model's Tunit
+TUNIT_SECONDS = {"S": 1.0, "M": 60.0, "H": 3600.0, "D": 86400.0}
+
+
+def _print(msg, quiet=False):
+    if not quiet:
+        print(msg)
+
+
+def create(ext_path, nc_file, quiet=False):
+    """
+    Create a new .ext file from the hard-coded TEMPLATE, pointing at nc_file.
+
+    Args:
+        ext_path (Path): Path of the .ext file to write.
+        nc_file (str): forcingFile value to write into the [Meteo] block.
+        quiet (bool): Suppress non-error output.
+    """
+    ext_path = Path(ext_path)
+    ext_path.parent.mkdir(parents=True, exist_ok=True)
+    # D-Flow FM input files conventionally use CRLF
+    with ext_path.open("w", newline="\r\n") as f:
+        f.write(TEMPLATE.format(forcing_file=nc_file))
+    _print(f"Created: {ext_path}", quiet)
+    _print(
+        f"  quantity=rainfall, forcingFile={nc_file}, forcingFileType=netcdf",
+        quiet,
+    )
+
+
+def find_mdu(ext_path) -> Optional[Path]:
+    """Locate the .mdu next to the .ext file (FM_model.mdu wins if several)."""
+    ext_path = Path(ext_path)
+    folder = ext_path.parent if str(ext_path.parent) else Path(".")
+    mdus = sorted(folder.glob("*.mdu"))
+    if not mdus:
+        return None
+    for m in mdus:
+        if m.stem.lower() == "fm_model":
+            return m
+    return mdus[0]
+
+
+def read_mdu_value(mdu_path, key) -> Optional[str]:
+    """Return the value of a single .mdu key, or None if it is absent."""
+    with Path(mdu_path).open("r", newline="") as f:
+        for line in f:
+            name, sep, rest = line.partition("=")
+            if sep and name.strip().lower() == key.lower():
+                return rest.partition("#")[0].strip()
+    return None
+
+
+def update_mdu(mdu_path, settings, backup=True, quiet=False):
+    """
+    Set the given key=value pairs in the .mdu, preserving layout and comments.
+
+    Args:
+        mdu_path (Path): Path to the model definition file.
+        settings (dict): Key/value pairs to apply.
+        backup (bool): Write a .bak copy before overwriting.
+        quiet (bool): Suppress non-error output.
+
+    Returns:
+        list[str]: Human-readable description of each change made.
+    """
+    mdu_path = Path(mdu_path)
+    wanted = {k.lower(): (k, str(v)) for k, v in settings.items()}
+
+    with mdu_path.open("r", newline="") as f:
+        lines = f.read().splitlines(keepends=True)
+
+    out, changed, seen = [], [], set()
+    for line in lines:
+        body = line.rstrip("\r\n")
+        eol = line[len(body):]
+        key, sep, rest = body.partition("=")
+        name = key.strip().lower()
+
+        if sep and name in wanted:
+            seen.add(name)
+            label, value = wanted[name]
+            val_part, hash_sep, comment = rest.partition("#")
+            old = val_part.strip()
+            if old != value:
+                # keep the original column of the trailing comment
+                lead = val_part[: len(val_part) - len(val_part.lstrip())] if old else " "
+                new_val = (lead + value).ljust(len(val_part))
+                if hash_sep and not new_val.endswith(" "):
+                    new_val += " "
+                line = f"{key}={new_val}{hash_sep}{comment}" + eol
+                changed.append(f"{label} = {old or '<empty>'} -> {value}")
+
+        out.append(line)
+
+    for name, (label, value) in wanted.items():
+        if name not in seen:
+            print(
+                f"! {label} not found in {mdu_path} - set it to {value} manually.",
+                file=sys.stderr,
+            )
+
+    if not changed:
+        _print(f"{mdu_path}: already up to date.", quiet)
+        return changed
+
+    if backup:
+        bak = mdu_path.with_suffix(mdu_path.suffix + ".bak")
+        shutil.copy2(mdu_path, bak)
+        _print(f"Backup written: {bak}", quiet)
+
+    with mdu_path.open("w", newline="") as f:
+        f.write("".join(out))
+    _print(f"Updated: {mdu_path}", quiet)
+    for c in changed:
+        _print(f"  {c}", quiet)
+    return changed
+
+
+def rewrite(ext_path, nc_file, backup=True, quiet=False):
+    """
+    Rewrite the [Meteo] blocks of an existing .ext file for NetCDF rainfall.
+
+    Args:
+        ext_path (Path): Path to the existing .ext file.
+        nc_file (str): forcingFile value to write.
+        backup (bool): Write a .bak copy before overwriting.
+        quiet (bool): Suppress non-error output.
+
+    Returns:
+        list[str]: Human-readable description of each change made.
+    """
+    ext_path = Path(ext_path)
+    if not ext_path.is_file():
+        raise FileNotFoundError(f"ext file not found: {ext_path}")
+
+    # newline='' keeps original CRLF/LF line endings intact
+    with ext_path.open("r", newline="") as f:
+        raw = f.read()
+
+    lines = raw.splitlines(keepends=True)
+    out = []
+    in_meteo = False
+    changed = []
+
+    for line in lines:
+        stripped = line.strip()
+        body, eol = line.rstrip("\r\n"), line[len(line.rstrip("\r\n")):]
+
+        if stripped.startswith("["):
+            in_meteo = stripped.lower() == "[meteo]"
+            out.append(line)
+            continue
+
+        if in_meteo and "=" in body:
+            key, _, old = body.partition("=")
+            # split off any inline comment so it is preserved
+            old_val, sep, comment = old.partition("#")
+            name = key.strip().lower()
+
+            new_val = None
+            if name == "forcingfile":
+                new_val = nc_file
+            elif name in REPLACEMENTS:
+                new_val = REPLACEMENTS[name]
+
+            if new_val is not None:
+                # keep original spacing style around '=' and the column of any
+                # trailing comment
+                lead = old_val[: len(old_val) - len(old_val.lstrip())]
+                padded = lead + new_val
+                if sep:  # an inline comment follows: keep its column
+                    padded = padded.ljust(len(old_val))
+                    if not padded.endswith(" "):
+                        padded += " "
+                body = f"{key}={padded}{sep}{comment}"
+                changed.append(f"{key.strip()} = {old_val.strip()} -> {new_val}")
+                line = body + eol
+
+        out.append(line)
+
+    if not changed:
+        _print("No [Meteo] keys matched - file left unchanged.", quiet)
+        return changed
+
+    if backup:
+        bak = ext_path.with_suffix(ext_path.suffix + ".bak")
+        shutil.copy2(ext_path, bak)
+        _print(f"Backup written: {bak}", quiet)
+
+    with ext_path.open("w", newline="") as f:
+        f.write("".join(out))
+
+    _print(f"Updated: {ext_path}", quiet)
+    for c in changed:
+        _print(f"  {c}", quiet)
+    return changed
+
+
+def _open_time_var(nc_path):
+    """Return (values, units_string) of the time coordinate of a NetCDF file."""
+
+    def pick(names, get_attr):
+        for cand in ("time", "TIME", "Time", "t"):
+            if cand in names:
+                return cand
+        for n in names:  # fall back to any CF time-like variable
+            units = (get_attr(n, "units") or "").lower()
+            if " since " in units or (get_attr(n, "axis") or "") == "T":
+                return n
+        return None
+
+    try:
+        import netCDF4  # the usual reader in a Delft3D FM python environment
+    except ImportError:
+        pass
+    else:
+        with netCDF4.Dataset(str(nc_path)) as ds:
+            def get(n, a):
+                return getattr(ds.variables[n], a, None)
+
+            name = pick(list(ds.variables), get)
+            if name is None:
+                raise ValueError(f"no time variable found in {nc_path}")
+            v = ds.variables[name]
+            return [float(x) for x in v[:].ravel()], str(getattr(v, "units", ""))
+
+    try:
+        import xarray as xr  # second choice
+    except ImportError:
+        pass
+    else:
+        with xr.open_dataset(str(nc_path), decode_times=False) as ds:
+            def get(n, a):
+                return ds[n].attrs.get(a)
+
+            name = pick(list(ds.variables), get)
+            if name is None:
+                raise ValueError(f"no time variable found in {nc_path}")
+            v = ds[name]
+            return [float(x) for x in v.values.ravel()], str(v.attrs.get("units", ""))
+
+    try:
+        from scipy.io import netcdf_file  # last resort, NetCDF3 only
+    except ImportError as exc:
+        raise ImportError(
+            "reading the NetCDF file needs one of netCDF4, xarray or scipy - "
+            "install with:  pip install netCDF4"
+        ) from exc
+
+    with netcdf_file(str(nc_path), "r", mmap=False) as ds:
+        def get(n, a):
+            val = getattr(ds.variables[n], a, None)
+            return val.decode() if isinstance(val, bytes) else val
+
+        name = pick(list(ds.variables), get)
+        if name is None:
+            raise ValueError(f"no time variable found in {nc_path}")
+        v = ds.variables[name]
+        units = getattr(v, "units", b"")
+        return (
+            [float(x) for x in v[:].ravel()],
+            units.decode() if isinstance(units, bytes) else str(units),
+        )
+
+
+def parse_cf_units(units):
+    """'minutes since 1970-01-01 00:00:00.0 +0000' -> (scale in s, epoch)."""
+    unit, _, epoch_txt = units.partition(" since ")
+    scale = CF_UNITS.get(unit.strip().lower())
+    if scale is None:
+        raise ValueError(f"unsupported time unit in '{units}'")
+
+    txt = epoch_txt.strip()
+    # drop the time zone, then normalise an ISO 'T' separator to a space
+    txt = re.sub(r"\s*(Z|UTC|GMT)\s*$", "", txt)          # ... 00:00:00 UTC
+    txt = re.sub(r"\s+[+-]\d{2}:?\d{2}\s*$", "", txt)     # ... 00:00:00 +0000
+    txt = re.sub(r"(?<=\d)T(?=\d)", " ", txt).strip()
+    for fmt in ("%Y-%m-%d %H:%M:%S.%f", "%Y-%m-%d %H:%M:%S", "%Y-%m-%d %H:%M", "%Y-%m-%d"):
+        try:
+            return scale, datetime.strptime(txt, fmt)
+        except ValueError:
+            continue
+    raise ValueError(f"cannot parse the reference date in '{units}'")
+
+
+def nc_time_range(nc_path):
+    """First and last time stamp in the NetCDF file, as datetimes."""
+    values, units = _open_time_var(nc_path)
+    if not values:
+        raise ValueError(f"the time variable in {nc_path} is empty")
+    scale, epoch = parse_cf_units(units)
+    lo, hi = min(values), max(values)
+    return epoch + timedelta(seconds=lo * scale), epoch + timedelta(seconds=hi * scale)
+
+
+def _fmt(seconds, tunit):
+    v = seconds / TUNIT_SECONDS.get(tunit.upper(), 1.0)
+    return str(int(round(v))) if abs(v - round(v)) < 1e-6 else f"{v:.6g}"
+
+
+def time_settings(nc_path, tunit="S", quiet=False):
+    """
+    RefDate / TStart / TStop derived from the NetCDF time axis.
+
+    RefDate is midnight of the first time stamp; TStart and TStop are offsets
+    from that midnight, expressed in the model's Tunit.
+
+    Args:
+        nc_path (Path): Path to the NetCDF forcing file.
+        tunit (str): Model time unit, one of S, M, H, D.
+        quiet (bool): Suppress non-error output.
+
+    Returns:
+        dict: {'RefDate': ..., 'TStart': ..., 'TStop': ...}
+    """
+    t0, t1 = nc_time_range(nc_path)
+    ref = t0.replace(hour=0, minute=0, second=0, microsecond=0)
+    _print(
+        f"NetCDF time span: {t0:%Y-%m-%d %H:%M:%S} -> {t1:%Y-%m-%d %H:%M:%S}",
+        quiet,
+    )
+    return {
+        "RefDate": ref.strftime("%Y%m%d"),
+        "TStart": _fmt((t0 - ref).total_seconds(), tunit),
+        "TStop": _fmt((t1 - ref).total_seconds(), tunit),
+    }
+
+
+def resolve_forcing_path(nc_file, ext_path):
+    """D-Flow FM resolves forcingFile relative to the .ext file, so rewrite a
+    path given relative to the cwd (or an absolute one) into that form."""
+    nc = Path(nc_file)
+    if not nc.exists():
+        return nc_file  # nothing to resolve against; write it through as given
+    try:
+        rel = os.path.relpath(nc.resolve(), Path(ext_path).resolve().parent)
+    except ValueError:  # different drive on Windows -> keep the absolute path
+        return str(nc.resolve())
+    return rel.replace(os.sep, "/")
+
+
+def set_nc_rainfall(
+    nc_file,
+    ext_file="dflowfm/FM_model_bnd.ext",
+    mdu_file=None,
+    update_time=True,
+    as_given=False,
+    backup=True,
+    quiet=False,
+):
+    """
+    Point a D-Flow FM model at a NetCDF rainfall forcing file.
+
+    Args:
+        nc_file (str): Path to the NetCDF forcing file.
+        ext_file (str): Path to the .ext file (created if missing).
+        mdu_file (str): Model definition file; defaults to the *.mdu next to
+            the .ext file.
+        update_time (bool): Also set RefDate/TStart/TStop from the NetCDF
+            time axis.
+        as_given (bool): Write the forcingFile path exactly as typed instead
+            of making it relative to the .ext file.
+        backup (bool): Write .bak copies before overwriting files.
+        quiet (bool): Suppress non-error output.
+
+    Returns:
+        tuple[Path, Path | None]: Paths to the (.ext, .mdu) touched; the .mdu
+        is None when no model definition file could be found.
+    """
+    nc_path = Path(nc_file)
+    ext_path = Path(ext_file)
+    forcing = nc_file if as_given else resolve_forcing_path(nc_file, ext_path)
+
+    created = not ext_path.is_file()
+    if created:
+        _print(f"{ext_path} not found - creating it.", quiet)
+        create(ext_path, forcing, quiet=quiet)
+    else:
+        rewrite(ext_path, forcing, backup=backup, quiet=quiet)
+
+    # ---- model definition file -------------------------------------------
+    settings = {}
+    if created:
+        # a freshly created .ext has to be registered in the .mdu
+        settings["ExtForceFileNew"] = ext_path.name
+
+    mdu_path = Path(mdu_file) if mdu_file else find_mdu(ext_path)
+    if mdu_path is None:
+        print(
+            f"! No *.mdu found in {ext_path.parent} - model times not updated.",
+            file=sys.stderr,
+        )
+        return ext_path, None
+    if not mdu_path.is_file():
+        print(
+            f"! mdu not found: {mdu_path} - model times not updated.",
+            file=sys.stderr,
+        )
+        return ext_path, None
+
+    if update_time:
+        if not nc_path.is_file():
+            print(
+                f"! {nc_path} not found - RefDate/TStart/TStop left unchanged.",
+                file=sys.stderr,
+            )
+        else:
+            tunit = (read_mdu_value(mdu_path, "Tunit") or "S").upper() or "S"
+            try:
+                settings.update(time_settings(nc_path, tunit, quiet=quiet))
+            except Exception as exc:  # unreadable file, odd time axis, ...
+                print(f"! could not read times from {nc_path}: {exc}", file=sys.stderr)
+                print("  RefDate/TStart/TStop left unchanged.", file=sys.stderr)
+
+    if settings:
+        update_mdu(mdu_path, settings, backup=backup, quiet=quiet)
+
+    return ext_path, mdu_path
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog='setncrain',
+        description='Point a D-Flow FM .ext/.mdu pair at a NetCDF rainfall forcing file',
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""
+Examples:
+  setncrain -i May28_Event.nc
+  setncrain -i C:/data/rain/May28_Event.nc
+  setncrain -i May28_Event.nc --ext dflowfm/FM_model_bnd.ext
+  setncrain -i May28_Event.nc --no-backup --as-given
+        """,
+    )
+
+    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 rainfall forcing file (*.nc)',
+    )
+    parser.add_argument(
+        '--ext',
+        default='dflowfm/FM_model_bnd.ext',
+        metavar='FILE',
+        help='Path to the .ext file (default: dflowfm/FM_model_bnd.ext)',
+    )
+    parser.add_argument(
+        '--mdu',
+        metavar='FILE',
+        help='Model definition file to update (default: the *.mdu next to the .ext)',
+    )
+    parser.add_argument(
+        '--no-time',
+        action='store_true',
+        help='Do not touch RefDate/TStart/TStop in the .mdu',
+    )
+    parser.add_argument(
+        '--as-given',
+        action='store_true',
+        help='Write the path exactly as typed instead of making it relative to the .ext file',
+    )
+    parser.add_argument(
+        '--no-backup',
+        action='store_true',
+        help='Do not write .bak copies',
+    )
+    parser.add_argument(
+        '-q', '--quiet',
+        action='store_true',
+        help='Suppress non-error output',
+    )
+
+    args = parser.parse_args()
+
+    if not args.input.lower().endswith('.nc'):
+        print("Error: forcing file must be a *.nc file", file=sys.stderr)
+        sys.exit(1)
+
+    try:
+        ext_path, mdu_path = set_nc_rainfall(
+            args.input,
+            ext_file=args.ext,
+            mdu_file=args.mdu,
+            update_time=not args.no_time,
+            as_given=args.as_given,
+            backup=not args.no_backup,
+            quiet=args.quiet,
+        )
+        if args.quiet:
+            print(ext_path)
+            if mdu_path is not None:
+                print(mdu_path)
+    except Exception as e:
+        print(f"Error: {e}", file=sys.stderr)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

{ncftools-0.6.2 → ncftools-0.9.0}/ncftools.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ncftools
-Version: 0.6.2
+Version: 0.9.0
 Summary: A collection of tools for working with NetCDF files
 Author-email: aaronchh <aaronhsu219@gmail.com>
 License-Expression: MIT
@@ -30,6 +30,8 @@ pip install -e .
 - **nc2shp**: Convert a UGRID-compliant NetCDF mesh file to ESRI Shapefiles
 - **transzone1**: Build a transition zone from triangle mesh faces and select all intersecting faces
 - **transzone2**: Extract the core transition zone — faces fully within the shrunk zone
+- **setncrain**: Point a D-Flow FM model (`.ext` / `.mdu`) at a NetCDF rainfall forcing file
+- **rnxml**: Rename `dimr.xml` to `dimr_config.xml`
 
 ## Usage
 
@@ -56,10 +58,13 @@ meshinfo -h
 
 ### nc2shp
 
-Convert a NetCDF mesh file to ESRI Shapefiles. Outputs `{stem}_faces.shp` and `{stem}_dissolved.shp` in the output directory.
+Convert a NetCDF mesh file to ESRI Shapefiles. Outputs `{stem}_faces.shp` in the output
+directory. Pass `-d`/`--dissolve` to additionally write `{stem}_dissolved.shp`, a single
+polygon dissolved from all mesh faces (slower on large meshes).
 
 ```bash
 nc2shp -i FlowFM_net.nc
+nc2shp -i mesh.nc -d
 nc2shp -i mesh.nc -o output --crs EPSG:4326
 nc2shp -i mesh.nc -q
 ```
@@ -89,6 +94,51 @@ transzone2 -i SHP_NC/FlowFM_net_faces.shp -z SHP_TRANS/trans_zone_extend.shp -o
 transzone2 -i SHP_NC/FlowFM_net_faces.shp -z SHP_TRANS/trans_zone_extend.shp -q
 ```
 
+### setncrain
+
+Point a D-Flow FM model at a NetCDF rainfall forcing file.
+
+Every `[Meteo]` block in the `.ext` file is rewritten to
+`quantity=rainfall`, `forcingFile=<your .nc>`, `forcingFileType=netcdf`.
+If the `.ext` file does not exist it is created from a built-in template and
+registered in the `.mdu` as `ExtForceFileNew`.
+
+The NetCDF time axis is read and the model times in the `.mdu` are set to match it
+(expressed in the model's `Tunit`):
+
+| Key | Value |
+| --- | --- |
+| `RefDate` | midnight of the first time stamp |
+| `TStart` | offset of the first time stamp from `RefDate` |
+| `TStop` | offset of the last time stamp from `RefDate` |
+
+The `forcingFile` path is written relative to the `.ext` file (D-Flow FM resolves it
+that way); use `--as-given` to write it exactly as typed. `.bak` copies of the
+modified files are written unless `--no-backup` is given.
+
+```bash
+setncrain -i May28_Event.nc
+setncrain -i data/May28_Event.nc --ext dflowfm/FM_model_bnd.ext
+setncrain -i May28_Event.nc --mdu dflowfm/FM_model.mdu --no-time
+setncrain -i May28_Event.nc --no-backup --as-given
+setncrain -i May28_Event.nc -q
+```
+
+### rnxml
+
+Rename `dimr.xml` to `dimr_config.xml`, the name the DIMR runner expects. The file
+stays in its folder and its contents are not touched.
+
+If `dimr_config.xml` already exists the rename is refused; pass `--force` to
+overwrite it (a `.bak` copy of the old target is kept unless `--no-backup`).
+
+```bash
+rnxml
+rnxml -i model/dimr.xml
+rnxml -i dimr.xml -o dimr_config.xml --force
+rnxml -i dimr.xml -q
+```
+
 ## Python API
 
 ```python

{ncftools-0.6.2 → ncftools-0.9.0}/ncftools.egg-info/SOURCES.txt

@@ -7,6 +7,8 @@ ncftools/cli.py
 ncftools/describe.py
 ncftools/meshinfo.py
 ncftools/nc2shp.py
+ncftools/rnxml.py
+ncftools/setncrain.py
 ncftools/transzone1.py
 ncftools/transzone2.py
 ncftools.egg-info/PKG-INFO

{ncftools-0.6.2 → ncftools-0.9.0}/ncftools.egg-info/entry_points.txt

@@ -3,5 +3,7 @@ meshinfo = ncftools.meshinfo:main
 nc2shp = ncftools.nc2shp:main
 ncftools = ncftools.cli:main
 ncftools-info = ncftools.describe:main
+rnxml = ncftools.rnxml:main
+setncrain = ncftools.setncrain:main
 transzone1 = ncftools.transzone1:main
 transzone2 = ncftools.transzone2:main

{ncftools-0.6.2 → ncftools-0.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ncftools"
-version = "0.6.2"
+version = "0.9.0"
 authors = [
     { name = "aaronchh", email = "aaronhsu219@gmail.com" },
 ]
@@ -36,3 +36,5 @@ meshinfo = "ncftools.meshinfo:main"
 nc2shp = "ncftools.nc2shp:main"
 transzone1 = "ncftools.transzone1:main"
 transzone2 = "ncftools.transzone2:main"
+setncrain = "ncftools.setncrain:main"
+rnxml = "ncftools.rnxml:main"