cffview 0.1.1__tar.gz

cffview-0.1.1/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, preamer
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cffview-0.1.1/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include src/cffview *.h

cffview-0.1.1/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: cffview
+Version: 0.1.1
+Summary: A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening Fluent
+Author-email: preamer <1524477126@qq.com>
+License-Expression: BSD-3-Clause
+Project-URL: Repository, https://github.com/preamer/cffview
+Keywords: fluent,cfd,ansys,hdf5,mesh
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: C++
+Classifier: Topic :: Scientific/Engineering
+Classifier: Environment :: Console
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: h5py>=3.16.0
+Requires-Dist: pyvista>=0.48.4
+Requires-Dist: sexpdata>=1.0.2
+Requires-Dist: tqdm>=4.68.3
+Dynamic: license-file
+
+[中文](README.zh.md)
+
+# fv
+
+A command-line tool for inspecting Ansys Fluent `.cas.h5` / `.msh.h5` files **without opening Fluent**.
+
+- Read solver settings, materials, boundary conditions, discretisation schemes, and more directly from the HDF5 file.
+- Visualise the mesh with [PyVista](https://pyvista.org).
+- Mesh reader based on a modified version of VTK's [`vtkFLUENTCFFReader`](https://github.com/Kitware/VTK/tree/master/IO/FLUENTCFF), with the VTK dependency removed. Supports all VTK cell types including polyhedra, for both `.cas.h5` and `.msh.h5`.
+
+---
+
+## Installation
+
+```bash
+pip install fv
+```
+
+### Build from source
+
+HDF5 development headers and libraries are required. The build script detects them automatically in the following order: `HDF5_DIR` environment variable → local `include/lib` → `pkg-config` → conda → Homebrew (macOS) → common system paths.
+
+```bash
+git clone https://github.com/preamer/fv.git
+cd fv
+pip install .
+```
+
+If auto-detection fails, set `HDF5_DIR` explicitly before installing.
+
+---
+
+## Usage
+
+```
+fv <file> [options]
+```
+
+### Options
+
+| Option | Description |
+|---|---|
+| `-v`, `--version` | Print the Fluent version stored in the file |
+| `--extract` | Dump raw Scheme settings to `general.scm` and `boundary.scm` |
+| `--showmesh` | Visualise the mesh interactively with PyVista |
+| `--solver` | Solver type, time, dimension, precision, turbulence model, energy, radiation, gravity |
+| `--mat` | Material properties |
+| `--bd` | Boundary condition settings |
+| `--ne` | Named expressions |
+| `--disc` | Discretisation schemes and relaxation factors |
+| `--rd` | Report definitions |
+| `--plotsets` | Plot sets |
+| `--monitorsets` | Monitor sets |
+| `--iter` | Iteration / time-step settings |
+| `--save` | Save the output to `<file>.json` |
+
+Multiple flags can be combined freely. Case settings flags (`--solver`, `--mat`, etc.) apply to `.cas.h5` files only.
+
+### Examples
+
+```bash
+# Show solver configuration and boundary conditions
+fv case.cas.h5 --solver --bd
+
+# Show all settings and save to JSON
+fv case.cas.h5 --solver --mat --bd --ne --disc --rd --iter --save
+
+# Visualise the mesh (.cas.h5 and .msh.h5 both supported)
+fv case.cas.h5 --showmesh
+fv mesh.msh.h5 --showmesh
+
+# Check the Fluent version embedded in the file
+fv case.cas.h5 --version
+
+# Extract raw Scheme strings for manual inspection
+fv case.cas.h5 --extract
+```
+
+---
+
+## File Format Support
+
+| Feature | `.cas.h5` | `.msh.h5` |
+|---|---|---|
+| Case settings (`--solver`, `--mat`, `--bd`, …) | ✅ | — |
+| Mesh visualisation (3D) | ✅ | ✅ |
+| Mesh visualisation (2D) | ✅ | ⚠️ partial |
+
+> **Note:** 2D `.msh.h5` face connectivity (C0/C1) parsing is not yet fully implemented.
+
+---
+
+## Supported Settings
+
+| Flag | Contents |
+|---|---|
+| `--solver` | Algorithm (PBNS/DBNS), steady/transient, 2D/3D, single/double precision, turbulence model, energy, radiation, gravity |
+| `--mat` | Fluid/solid materials with properties and evaluation methods |
+| `--bd` | Velocity-inlet, pressure-outlet, mass-flow-inlet/outlet, wall (thermal & motion BC), porous-jump, interior, symmetry, … |
+| `--ne` | Named expressions defined in the case |
+| `--disc` | Per-equation scheme (Second Order Upwind, QUICK, …) and under-relaxation / pseudo-transient factors |
+| `--rd` | Report definitions (volume, surface, flux) with field, zones, and per-zone flag |
+| `--plotsets` | Plot set configurations |
+| `--monitorsets` | Monitor set configurations |
+| `--iter` | Iteration count (steady) or time-step size, number of steps, max inner iterations (transient) |
+
+---
+
+## License
+
+[BSD-3-Clause](LICENSE)

cffview-0.1.1/README.md

@@ -0,0 +1,111 @@
+[中文](README.zh.md)
+
+# fv
+
+A command-line tool for inspecting Ansys Fluent `.cas.h5` / `.msh.h5` files **without opening Fluent**.
+
+- Read solver settings, materials, boundary conditions, discretisation schemes, and more directly from the HDF5 file.
+- Visualise the mesh with [PyVista](https://pyvista.org).
+- Mesh reader based on a modified version of VTK's [`vtkFLUENTCFFReader`](https://github.com/Kitware/VTK/tree/master/IO/FLUENTCFF), with the VTK dependency removed. Supports all VTK cell types including polyhedra, for both `.cas.h5` and `.msh.h5`.
+
+---
+
+## Installation
+
+```bash
+pip install fv
+```
+
+### Build from source
+
+HDF5 development headers and libraries are required. The build script detects them automatically in the following order: `HDF5_DIR` environment variable → local `include/lib` → `pkg-config` → conda → Homebrew (macOS) → common system paths.
+
+```bash
+git clone https://github.com/preamer/fv.git
+cd fv
+pip install .
+```
+
+If auto-detection fails, set `HDF5_DIR` explicitly before installing.
+
+---
+
+## Usage
+
+```
+fv <file> [options]
+```
+
+### Options
+
+| Option | Description |
+|---|---|
+| `-v`, `--version` | Print the Fluent version stored in the file |
+| `--extract` | Dump raw Scheme settings to `general.scm` and `boundary.scm` |
+| `--showmesh` | Visualise the mesh interactively with PyVista |
+| `--solver` | Solver type, time, dimension, precision, turbulence model, energy, radiation, gravity |
+| `--mat` | Material properties |
+| `--bd` | Boundary condition settings |
+| `--ne` | Named expressions |
+| `--disc` | Discretisation schemes and relaxation factors |
+| `--rd` | Report definitions |
+| `--plotsets` | Plot sets |
+| `--monitorsets` | Monitor sets |
+| `--iter` | Iteration / time-step settings |
+| `--save` | Save the output to `<file>.json` |
+
+Multiple flags can be combined freely. Case settings flags (`--solver`, `--mat`, etc.) apply to `.cas.h5` files only.
+
+### Examples
+
+```bash
+# Show solver configuration and boundary conditions
+fv case.cas.h5 --solver --bd
+
+# Show all settings and save to JSON
+fv case.cas.h5 --solver --mat --bd --ne --disc --rd --iter --save
+
+# Visualise the mesh (.cas.h5 and .msh.h5 both supported)
+fv case.cas.h5 --showmesh
+fv mesh.msh.h5 --showmesh
+
+# Check the Fluent version embedded in the file
+fv case.cas.h5 --version
+
+# Extract raw Scheme strings for manual inspection
+fv case.cas.h5 --extract
+```
+
+---
+
+## File Format Support
+
+| Feature | `.cas.h5` | `.msh.h5` |
+|---|---|---|
+| Case settings (`--solver`, `--mat`, `--bd`, …) | ✅ | — |
+| Mesh visualisation (3D) | ✅ | ✅ |
+| Mesh visualisation (2D) | ✅ | ⚠️ partial |
+
+> **Note:** 2D `.msh.h5` face connectivity (C0/C1) parsing is not yet fully implemented.
+
+---
+
+## Supported Settings
+
+| Flag | Contents |
+|---|---|
+| `--solver` | Algorithm (PBNS/DBNS), steady/transient, 2D/3D, single/double precision, turbulence model, energy, radiation, gravity |
+| `--mat` | Fluid/solid materials with properties and evaluation methods |
+| `--bd` | Velocity-inlet, pressure-outlet, mass-flow-inlet/outlet, wall (thermal & motion BC), porous-jump, interior, symmetry, … |
+| `--ne` | Named expressions defined in the case |
+| `--disc` | Per-equation scheme (Second Order Upwind, QUICK, …) and under-relaxation / pseudo-transient factors |
+| `--rd` | Report definitions (volume, surface, flux) with field, zones, and per-zone flag |
+| `--plotsets` | Plot set configurations |
+| `--monitorsets` | Monitor set configurations |
+| `--iter` | Iteration count (steady) or time-step size, number of steps, max inner iterations (transient) |
+
+---
+
+## License
+
+[BSD-3-Clause](LICENSE)

cffview-0.1.1/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools>=83.0.0", "wheel", "pybind11>=3.0.4", "numpy>=1.20.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cffview"
+version = "0.1.1"
+description = "A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening Fluent"
+readme = "README.md"
+requires-python = ">=3.11"
+authors = [{ name = "preamer", email = "1524477126@qq.com" }]
+keywords = ["fluent", "cfd", "ansys", "hdf5", "mesh"]
+license = "BSD-3-Clause"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: C++",
+    "Topic :: Scientific/Engineering",
+    "Environment :: Console",
+]
+dependencies = [
+    "h5py>=3.16.0",
+    "pyvista>=0.48.4",
+    "sexpdata>=1.0.2",
+    "tqdm>=4.68.3",
+]
+
+[project.scripts]
+cffview = "cffview.main:main"
+
+[project.urls]
+Repository = "https://github.com/preamer/cffview"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.cibuildwheel]
+build = "cp311-* cp312-* cp313-* cp314-*"
+skip = ["*-win32", "*-musllinux*", "*-manylinux_i686"]
+
+[tool.cibuildwheel.linux]
+before-all = "bash tools/build_hdf5_linux.sh"
+environment = { HDF5_DIR = "/opt/hdf5", PIP_ONLY_BINARY = ":all:" }
+
+[tool.cibuildwheel.macos]
+environment = { HDF5_DIR = "/tmp/hdf5", MACOSX_DEPLOYMENT_TARGET = "11.0", DYLD_LIBRARY_PATH = "/tmp/hdf5/lib", CC = "clang", CXX = "clang++" }
+before-all = "bash tools/build_hdf5_macos.sh"
+
+[tool.cibuildwheel.windows]
+before-all = "powershell tools/build_hdf5_windows.ps1"
+environment = { HDF5_DIR = "C:/Users/runneradmin/hdf5" }
+repair-wheel-command = "delvewheel repair --add-path C:\\Users\\runneradmin\\hdf5\\bin -w {dest_dir} {wheel}"

cffview-0.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cffview-0.1.1/setup.py

@@ -0,0 +1,120 @@
+import os
+import sys
+import warnings
+from pathlib import Path
+
+import pybind11
+import numpy as np
+from setuptools import setup
+from pybind11.setup_helpers import Pybind11Extension, build_ext
+
+
+def _has_hdf5_header(d: Path) -> bool:
+    return (d / "hdf5.h").exists()
+
+
+def find_hdf5() -> tuple[list, list, list, list, list]:
+    """Returns (include_dirs, library_dirs, libraries, define_macros, extra_link_args)."""
+    include_dirs: list[str] = []
+    library_dirs: list[str] = []
+    libraries:    list[str] = ["hdf5"]
+    define_macros:   list = []
+    extra_link_args: list = []
+
+    hdf5_dir = os.environ.get("HDF5_DIR", "").strip()
+    if hdf5_dir:
+        p = Path(hdf5_dir)
+        if (p / "include").is_dir():
+            include_dirs.append(str(p / "include"))
+        if (p / "lib").is_dir():
+            library_dirs.append(str(p / "lib"))
+
+    if not include_dirs:
+        local_inc, local_lib = Path("include"), Path("lib")
+        if _has_hdf5_header(local_inc):
+            include_dirs.append(str(local_inc))
+        if local_lib.is_dir() and any(local_lib.iterdir()):
+            library_dirs.append(str(local_lib))
+
+        if sys.platform == "win32":
+            define_macros.append(("H5_BUILT_AS_DYNAMIC_LIB", None))
+            conda_base = Path(sys.prefix) / "Library"
+            if _has_hdf5_header(conda_base / "include"):
+                include_dirs.append(str(conda_base / "include"))
+                library_dirs.append(str(conda_base / "lib"))
+        elif sys.platform.startswith("linux"):
+            for candidate in [Path("/usr/include/hdf5/serial"), Path("/usr/include")]:
+                if _has_hdf5_header(candidate):
+                    include_dirs.append(str(candidate))
+                    break
+            for candidate in [Path("/usr/lib/x86_64-linux-gnu/hdf5/serial"), Path("/usr/lib64")]:
+                if candidate.is_dir():
+                    library_dirs.append(str(candidate))
+                    break
+
+    if sys.platform == "win32":
+        define_macros.append(("H5_BUILT_AS_DYNAMIC_LIB", None))
+        found_lib = False
+        for ldir in library_dirs:
+            lib_path = Path(ldir)
+            if (lib_path / "hdf5.lib").exists():
+                libraries = ["hdf5"]
+                found_lib = True
+                break
+            elif (lib_path / "libhdf5.lib").exists():
+                libraries = ["libhdf5"]
+                found_lib = True
+                break
+        if not found_lib:
+            libraries = ["hdf5"]
+    else:
+        for ldir in library_dirs:
+            extra_link_args.append(f"-Wl,-rpath,{ldir}")
+
+    if not any(_has_hdf5_header(Path(d)) for d in include_dirs):
+        warnings.warn(
+            f"\n\n*** Could not locate hdf5.h inside {include_dirs} — build will likely fail. ***\n"
+            "Please check if HDF5_DIR is set correctly.\n",
+            stacklevel=2
+        )
+
+    return include_dirs, library_dirs, libraries, define_macros, extra_link_args
+
+
+def get_compile_args() -> list[str]:
+    if sys.platform == "win32":
+        return ["/utf-8", "/EHsc", "/bigobj", "/O2"]
+    return ["-O2", "-fvisibility=hidden"]
+
+
+# ---------------------------------------------------------------------------
+# Extension module
+# ---------------------------------------------------------------------------
+hdf5_inc, hdf5_lib, hdf5_libs, macros, link_args = find_hdf5()
+
+ext_modules = [
+    Pybind11Extension(
+        "cffview.mesh_reader",
+        sources=[
+            "src/cffview/main.cxx",
+            "src/cffview/vtkFLUENTCFFReader.cxx",
+        ],
+        include_dirs=[
+            *hdf5_inc,
+            str(Path("include")),
+            np.get_include(),
+            pybind11.get_include(),
+        ],
+        library_dirs=[*hdf5_lib, str(Path("lib"))],
+        libraries=hdf5_libs,
+        define_macros=macros,
+        extra_compile_args=get_compile_args(),
+        extra_link_args=link_args,
+        cxx_std=17,
+    ),
+]
+
+setup(
+    ext_modules=ext_modules,
+    cmdclass={"build_ext": build_ext},
+)