NCFTOOLS
A collection of Python tools for working with NetCDF files.
Installation
pip install -e .
Features
- meshinfo: Display mesh information from FlowFM NetCDF files (node/face/edge counts, element types, spatial extent)
- ncinfo: List the variables (and optionally the dimensions) in one or more NetCDF files
- nc2shp: Convert a UGRID-compliant NetCDF mesh file to ESRI Shapefiles
- shp2nc: Rebuild a UGRID mesh NetCDF (D-Flow FM net file) from a cell-polygon shapefile
- 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
- rnxml: Rename
dimr.xmltodimr_config.xml
Usage
Check version
ncftools --version
List all available commands
ncftools-info
meshinfo
Display mesh information from a FlowFM NetCDF file. UGRID (Mesh2d_*), D-Flow FM 2D3D
(mesh2d_*, e.g. from RGFGRID) and old-format (NetNode/NetLink) net files are
detected automatically.
meshinfo FlowFM_net.nc
meshinfo -h
ncinfo
List the variables in one or more NetCDF files: name, data type, shape, dimensions,
units and long name. Pass -d/--dims to also list the dimensions (name, size,
unlimited).
ncinfo FlowFM_map.nc
ncinfo FlowFM_map.nc -d
ncinfo a.nc b.nc c.nc
nc2shp
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).
nc2shp FlowFM_net.nc
nc2shp mesh.nc -d
nc2shp mesh.nc -o output --crs EPSG:4326
nc2shp mesh.nc -q
shp2nc
Rebuild a D-Flow FM 2D net file (UGRID, mesh2d_* variables) from a polygon shapefile in
which every polygon is one mesh cell — the reverse of nc2shp. Vertices shared by
neighbouring cells are merged into one node (within --tol, default 0.001 map units),
cells are made counter-clockwise, and edges and face centres are derived. Numeric
shapefile attributes are kept as face variables. The CRS comes from the .prj; --crs
is used only when it is missing. Writes {stem}_net.nc unless -o is given.
shp2nc mesh.shp
shp2nc mesh.shp -o FlowFM_net.nc
shp2nc mesh.shp --tol 0.01 --node-z -5.0
shp2nc mesh.shp -q
transzone1
Buffer triangle mesh faces by +1 m to form a transition zone, then select all faces that intersect it.
Outputs trans_zone.shp and trans_zone_extend.shp.
Triangles are identified from the type attribute column when present; otherwise they are
detected automatically by vertex count (closed rings with 3 unique vertices).
transzone1 SHP_NC/FlowFM_net_faces.shp
transzone1 SHP_NC/FlowFM_net_faces.shp -o SHP_TRANS
transzone1 SHP_NC/FlowFM_net_faces.shp -q
transzone2
Shrink trans_zone_extend.shp (output of transzone1) by −1 m and select faces fully within the core zone.
Outputs trans_zone_core.shp.
transzone2 SHP_NC/FlowFM_net_faces.shp -z SHP_TRANS/trans_zone_extend.shp
transzone2 SHP_NC/FlowFM_net_faces.shp -z SHP_TRANS/trans_zone_extend.shp -o SHP_TRANS
transzone2 SHP_NC/FlowFM_net_faces.shp -z SHP_TRANS/trans_zone_extend.shp -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).
rnxml
rnxml model/dimr.xml
rnxml dimr.xml -o dimr_config.xml --force
rnxml dimr.xml -q
Python API
from ncftools import meshinfo
meshinfo.show_mesh_info("FlowFM_net.nc")
Metadata
Release files for ncftools 0.13.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| ncftools-0.13.0.tar.gz | 19.6 kB | With provenance | Details for ncftools-0.13.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| ncftools-0.13.0-py3-none-any.whl | Python 3 | none | any | Details for ncftools-0.13.0-py3-none-any.whl |
Total release size: 44.8 kB
Release files / ncftools-0.13.0.tar.gz
| Download URL | ncftools-0.13.0.tar.gz |
|---|---|
| Size | 19.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6176fee101719f30bbae5e30ec6d1503c661e6cef41a1656ba64cebeef9fdbce
|
|
BLAKE2b-256 checksum How to use checksums |
80cdca9447b70a04959fe1aea465225e6a32b42a82d3fc98a407d7fef6480b83
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2026.
Transparency logRelease files / ncftools-0.13.0-py3-none-any.whl
| Download URL | ncftools-0.13.0-py3-none-any.whl |
|---|---|
| Size | 25.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8a2e39222872aaac54e1efe4c5846a732c80d828d472411efbea595ebf38ce76
|
|
BLAKE2b-256 checksum How to use checksums |
7d72c3c14d4838669ef9f1e88186aca8ce96257e3da10f558c536a3e79449a39
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2026.
Transparency logSecurity for ncftools 0.13.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for ncftools-0.13.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 16, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.