cffview 0.2.1__tar.gz → 0.2.2__tar.gz

{cffview-0.2.1/src/cffview.egg-info → cffview-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cffview
-Version: 0.2.1
+Version: 0.2.2
 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
@@ -20,9 +20,12 @@ 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
 
+[![PyPI](https://img.shields.io/pypi/v/cffview.svg?logo=python&logoColor=white)](https://pypi.org/project/cffview/)
+[![Python versions](https://img.shields.io/pypi/pyversions/cffview.svg?color=orange&logo=python&label=python&logoColor=white)](https://pypi.org/project/cffview)
+[![CI](https://github.com/preamer/cffview/actions/workflows/build_wheels.yml/badge.svg)](https://github.com/preamer/cffview/actions/workflows/build_wheels.yml)
+
 [中文](README.zh.md)
 
 # cffview
@@ -36,11 +39,13 @@ A command-line tool for inspecting Ansys Fluent `.cas.h5` / `.msh.h5` files **wi
 
 ## Installation
 
+### PyPI
+
 ```bash
 pip install cffview
 ```
 
-### Build from source
+### From source
 
 ```bash
 git clone https://github.com/preamer/cffview.git
@@ -60,7 +65,7 @@ cffview <file> [options]
 
 | Option | Description |
 |---|---|
-| `-v`, `--version` | Print the Fluent version stored in the file |
+| `--version` | Print the Fluent version of 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 |
@@ -72,6 +77,8 @@ cffview <file> [options]
 | `--plotsets` | Plot sets |
 | `--monitorsets` | Monitor sets |
 | `--iter` | Iteration / time-step settings |
+| `--contours` | Graphics contours settings |
+| `--vectors` | Graphics vectors 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.
@@ -79,17 +86,17 @@ Multiple flags can be combined freely. Case settings flags (`--solver`, `--mat`,
 ### Examples
 
 ```bash
+# Show all settings and save to JSON
+cffview case.cas.h5 --save
+
 # Show solver configuration and boundary conditions
 cffview case.cas.h5 --solver --bd
 
-# Show all settings and save to JSON
-cffview case.cas.h5 --solver --mat --bd --ne --disc --rd --iter --save
-
-# Visualise the mesh (.cas.h5 and .msh.h5 both supported)
+# Visualise the mesh
 cffview case.cas.h5 --showmesh
 cffview mesh.msh.h5 --showmesh
 
-# Check the Fluent version embedded in the file
+# Check the Fluent version of file
 cffview case.cas.h5 --version
 
 # Extract raw Scheme strings for manual inspection
@@ -98,32 +105,6 @@ cffview case.cas.h5 --extract
 
 ---
 
-## File Format Support
-
-| Feature | `.cas.h5` | `.msh.h5` |
-|---|---|---|
-| Case settings (`--solver`, `--mat`, `--bd`, …) | ✅ | — |
-| Mesh visualisation (3D) | ✅ | ✅ |
-| Mesh visualisation (2D) | ✅ | ✅ |
-
----
-
-## 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.2.1 → cffview-0.2.2}/README.md

@@ -1,3 +1,7 @@
+[![PyPI](https://img.shields.io/pypi/v/cffview.svg?logo=python&logoColor=white)](https://pypi.org/project/cffview/)
+[![Python versions](https://img.shields.io/pypi/pyversions/cffview.svg?color=orange&logo=python&label=python&logoColor=white)](https://pypi.org/project/cffview)
+[![CI](https://github.com/preamer/cffview/actions/workflows/build_wheels.yml/badge.svg)](https://github.com/preamer/cffview/actions/workflows/build_wheels.yml)
+
 [中文](README.zh.md)
 
 # cffview
@@ -11,11 +15,13 @@ A command-line tool for inspecting Ansys Fluent `.cas.h5` / `.msh.h5` files **wi
 
 ## Installation
 
+### PyPI
+
 ```bash
 pip install cffview
 ```
 
-### Build from source
+### From source
 
 ```bash
 git clone https://github.com/preamer/cffview.git
@@ -35,7 +41,7 @@ cffview <file> [options]
 
 | Option | Description |
 |---|---|
-| `-v`, `--version` | Print the Fluent version stored in the file |
+| `--version` | Print the Fluent version of 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 |
@@ -47,6 +53,8 @@ cffview <file> [options]
 | `--plotsets` | Plot sets |
 | `--monitorsets` | Monitor sets |
 | `--iter` | Iteration / time-step settings |
+| `--contours` | Graphics contours settings |
+| `--vectors` | Graphics vectors 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.
@@ -54,17 +62,17 @@ Multiple flags can be combined freely. Case settings flags (`--solver`, `--mat`,
 ### Examples
 
 ```bash
+# Show all settings and save to JSON
+cffview case.cas.h5 --save
+
 # Show solver configuration and boundary conditions
 cffview case.cas.h5 --solver --bd
 
-# Show all settings and save to JSON
-cffview case.cas.h5 --solver --mat --bd --ne --disc --rd --iter --save
-
-# Visualise the mesh (.cas.h5 and .msh.h5 both supported)
+# Visualise the mesh
 cffview case.cas.h5 --showmesh
 cffview mesh.msh.h5 --showmesh
 
-# Check the Fluent version embedded in the file
+# Check the Fluent version of file
 cffview case.cas.h5 --version
 
 # Extract raw Scheme strings for manual inspection
@@ -73,32 +81,6 @@ cffview case.cas.h5 --extract
 
 ---
 
-## File Format Support
-
-| Feature | `.cas.h5` | `.msh.h5` |
-|---|---|---|
-| Case settings (`--solver`, `--mat`, `--bd`, …) | ✅ | — |
-| Mesh visualisation (3D) | ✅ | ✅ |
-| Mesh visualisation (2D) | ✅ | ✅ |
-
----
-
-## 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.2.1 → cffview-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cffview"
-version = "0.2.1"
+version = "0.2.2"
 description = "A Python CLI tool to inspect Ansys Fluent .cas.h5/.msh.h5 files without opening Fluent"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -21,12 +21,7 @@ classifiers = [
     "Topic :: Scientific/Engineering",
     "Environment :: Console",
 ]
-dependencies = [
-    "h5py>=3.16.0",
-    "pyvista>=0.48.4",
-    "sexpdata>=1.0.2",
-    "tqdm>=4.68.3",
-]
+dependencies = ["h5py>=3.16.0", "pyvista>=0.48.4", "sexpdata>=1.0.2"]
 
 [project.scripts]
 cffview = "cffview.main:main"

{cffview-0.2.1 → cffview-0.2.2}/src/cffview/main.py

@@ -1,3 +1,6 @@
+from typing import Literal
+
+
 def print_version(file_path: str) -> str:
     """Get the version of the .h5 file
 
@@ -17,7 +20,11 @@ def print_version(file_path: str) -> str:
         print(f['/settings/Version'][0].decode())
 
 
-def read_case(file_path: str, **kwargs) -> dict[str]:
+def read_case(file_path: str, **kwargs) -> dict[
+    Literal['solver', 'materials', 'boundary', 'named-expressions',
+            'disc-scheme', 'report-definitions', 'plotsets', 'monitorsets', 'iter'],
+    dict[str]
+]:
     """Read the cas.h5 file
 
     Parameters
@@ -27,7 +34,7 @@ def read_case(file_path: str, **kwargs) -> dict[str]:
 
     Returns
     -------
-    dict[str]
+    dict[Literal[...], dict[str]]
         A dictionary containing the case settings
     """
     import re
@@ -325,6 +332,76 @@ def read_case(file_path: str, **kwargs) -> dict[str]:
                     general_info
                 ).group(1)
 
+    if kwargs['contours']:
+        import sexpdata
+
+        data['contours'] = {}
+        contours = re.search(
+            r'(\(graphics/contours.*)',
+            general_info,
+            re.M
+        ).group(1)
+        contours: list = sexpdata.loads(contours, true=None)[1]
+        for contour in contours:
+            contour_dict = {
+                str(property_[0]): str(property_[2])
+                for property_ in contour
+                if str(property_[0]) not in [
+                    'locations', 'location-ids', 'options',
+                    'range-options', 'range-option', 'surfaces-list',
+                    'color-map', 'colorings', 'annotations-list',
+                ]
+            }
+            contour_dict['surface-list'] = contour[2][1]
+            contour_dict['range-options'] = {
+                str(range_option[0]): str(range_option[2])
+                for range_option in contour[6][1:]
+            }
+            contour_dict['color-map'] = {
+                str(color_map[0]): str(color_map[2])
+                for color_map in contour[-7][1:]
+            }
+            data['contours'][contour_dict['name']] = contour_dict
+
+    if kwargs['vectors']:
+        import sexpdata
+
+        data['vectors'] = {}
+        vectors = re.search(
+            r'(\(graphics/vectors\s.*)',
+            general_info,
+            re.M
+        ).group(1)
+        vectors: list = sexpdata.loads(vectors, true=None)[1]
+        for vector in vectors:
+            vector_dict = {
+                str(property_[0]): str(property_[2])
+                for property_ in vector
+                if str(property_[0]) not in [
+                    'locations', 'location-ids', 'options', 'scale',
+                    'range-options', 'range-option', 'surfaces-list',
+                    'color-map', 'vector-opt', 'annotations-list',
+                ]
+            }
+            vector_dict['surface-list'] = vector[3][1]
+            vector_dict['range-options'] = {
+                str(range_option[0]): str(range_option[2])
+                for range_option in vector[7][1:]
+            }
+            vector_dict['scale'] = {
+                str(scale[0]): str(scale[2])
+                for scale in vector[9][1:]
+            }
+            vector_dict['vector-opt'] = {
+                str(vector_opt[0]): str(vector_opt[2])
+                for vector_opt in vector[-6][1:]
+            }
+            vector_dict['color-map'] = {
+                str(color_map[0]): str(color_map[2])
+                for color_map in vector[-5][1:]
+            }
+            data['vectors'][vector_dict['name']] = vector_dict
+
     return data
 
 
@@ -358,7 +435,7 @@ def show_mesh(file_path: str) -> None:
     import pyvista as pv
     if file_path.endswith('cas.h5'):
         pv.plot(
-            pv.read(file_path, progress_bar=True),
+            pv.read(file_path),
             show_edges=True,
             show_axes=True,
             smooth_shading=True,
@@ -434,73 +511,26 @@ def main() -> None:
         help="path to the .h5 file"
     )
 
-    parser.add_argument(
-        "--extract",
-        action="store_true",
-        help="extract cas.h5 general and boundary string to files"
-    )
-
-    parser.add_argument(
-        "-v", "--version",
-        action="store_true",
-        help="show the version of the .h5 file"
-    )
-
-    parser.add_argument(
-        "--solver",
-        action="store_true",
-        help="show solver settings"
-    )
-    parser.add_argument(
-        "--mat", "--materials",
-        action="store_true",
-        help="show materials settings"
-    )
-    parser.add_argument(
-        "--bd", "--boundary",
-        action="store_true",
-        help="show boundary settings"
-    )
-    parser.add_argument(
-        "--ne", "--named-expressions",
-        action="store_true",
-        help="show named-expressions settings"
-    )
-    parser.add_argument(
-        "--disc",
-        action="store_true",
-        help="show disc-scheme and relax-factor settings"
-    )
-    parser.add_argument(
-        "--rd", "--report-definitions",
-        action="store_true",
-        help="show report-definitions settings"
-    )
-    parser.add_argument(
-        "--plotsets",
-        action="store_true",
-        help="show report-definitions plotsets settings"
-    )
-    parser.add_argument(
-        "--monitorsets",
-        action="store_true",
-        help="show report-definitions monitorsets settings"
-    )
-    parser.add_argument(
-        "--iter",
-        action="store_true",
-        help="show iteration settings"
-    )
-    parser.add_argument(
-        "--save",
-        action="store_true",
-        help="save output to file"
-    )
-    parser.add_argument(
-        "--showmesh",
-        action="store_true",
-        help="show mesh using pyvista"
-    )
+    ARGUMENTS = [
+        (("--extract",), "extract cas.h5 general and boundary string to files"),
+        (("--version",), "show the version of the .h5 file"),
+        (("--solver",), "show solver settings"),
+        (("--mat", "--materials"), "show materials settings"),
+        (("--bd", "--boundary"), "show boundary settings"),
+        (("--ne", "--named-expressions"), "show named-expressions settings"),
+        (("--disc",), "show disc-scheme and relax-factor settings"),
+        (("--rd", "--report-definitions"), "show report-definitions settings"),
+        (("--plotsets",), "show report-definitions plotsets settings"),
+        (("--monitorsets",), "show report-definitions monitorsets settings"),
+        (("--iter",), "show iteration settings"),
+        (("--contours",), "show graphics contours settings"),
+        (("--vectors",), "show graphics vectors settings"),
+        (("--save",), "save output to file"),
+        (("--showmesh",), "show mesh using pyvista"),
+    ]
+
+    for flags, help_text in ARGUMENTS:
+        parser.add_argument(*flags, action="store_true", help=help_text)
 
     args = parser.parse_args()
 
@@ -524,6 +554,8 @@ def main() -> None:
                 'rd': args.rd,
                 'plotsets': args.plotsets,
                 'monitorsets': args.monitorsets,
+                'contours': args.contours,
+                'vectors': args.vectors,
                 'iter': args.iter
             }
             output = read_case(args.file_path, **kwargs)

{cffview-0.2.1 → cffview-0.2.2/src/cffview.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cffview
-Version: 0.2.1
+Version: 0.2.2
 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
@@ -20,9 +20,12 @@ 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
 
+[![PyPI](https://img.shields.io/pypi/v/cffview.svg?logo=python&logoColor=white)](https://pypi.org/project/cffview/)
+[![Python versions](https://img.shields.io/pypi/pyversions/cffview.svg?color=orange&logo=python&label=python&logoColor=white)](https://pypi.org/project/cffview)
+[![CI](https://github.com/preamer/cffview/actions/workflows/build_wheels.yml/badge.svg)](https://github.com/preamer/cffview/actions/workflows/build_wheels.yml)
+
 [中文](README.zh.md)
 
 # cffview
@@ -36,11 +39,13 @@ A command-line tool for inspecting Ansys Fluent `.cas.h5` / `.msh.h5` files **wi
 
 ## Installation
 
+### PyPI
+
 ```bash
 pip install cffview
 ```
 
-### Build from source
+### From source
 
 ```bash
 git clone https://github.com/preamer/cffview.git
@@ -60,7 +65,7 @@ cffview <file> [options]
 
 | Option | Description |
 |---|---|
-| `-v`, `--version` | Print the Fluent version stored in the file |
+| `--version` | Print the Fluent version of 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 |
@@ -72,6 +77,8 @@ cffview <file> [options]
 | `--plotsets` | Plot sets |
 | `--monitorsets` | Monitor sets |
 | `--iter` | Iteration / time-step settings |
+| `--contours` | Graphics contours settings |
+| `--vectors` | Graphics vectors 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.
@@ -79,17 +86,17 @@ Multiple flags can be combined freely. Case settings flags (`--solver`, `--mat`,
 ### Examples
 
 ```bash
+# Show all settings and save to JSON
+cffview case.cas.h5 --save
+
 # Show solver configuration and boundary conditions
 cffview case.cas.h5 --solver --bd
 
-# Show all settings and save to JSON
-cffview case.cas.h5 --solver --mat --bd --ne --disc --rd --iter --save
-
-# Visualise the mesh (.cas.h5 and .msh.h5 both supported)
+# Visualise the mesh
 cffview case.cas.h5 --showmesh
 cffview mesh.msh.h5 --showmesh
 
-# Check the Fluent version embedded in the file
+# Check the Fluent version of file
 cffview case.cas.h5 --version
 
 # Extract raw Scheme strings for manual inspection
@@ -98,32 +105,6 @@ cffview case.cas.h5 --extract
 
 ---
 
-## File Format Support
-
-| Feature | `.cas.h5` | `.msh.h5` |
-|---|---|---|
-| Case settings (`--solver`, `--mat`, `--bd`, …) | ✅ | — |
-| Mesh visualisation (3D) | ✅ | ✅ |
-| Mesh visualisation (2D) | ✅ | ✅ |
-
----
-
-## 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.2.1 → cffview-0.2.2}/src/cffview.egg-info/requires.txt

@@ -1,4 +1,3 @@
 h5py>=3.16.0
 pyvista>=0.48.4
 sexpdata>=1.0.2
-tqdm>=4.68.3