cffview
CFF is an abbreviation for Ansys Common Fluids Format.
A command-line tool for viewing Ansys Fluent .cas.h5 / .msh.h5 / .dat.h5 files without opening Fluent.
- Read solver settings, materials, boundary conditions, discretisation schemes, and more directly from the HDF5 file.
- Browse the parsed settings in an interactive terminal UI (
--tui). - Visualise mesh or data with PyVista.
Installation
PyPI
pip install cffview
From source
git clone https://github.com/aiwaonly/cffview.git
cd cffview
pip install .
Usage
cffview <file> [options]
Options
| Option | Description |
|---|---|
--version |
Print the Fluent version of file |
--extract |
Dump raw Scheme settings to general.scm / boundary.scm / cortex.scm |
--plotmesh |
Visualise the mesh interactively with PyVista |
--plotdata |
Visualise the data interactively with PyVista (may not work, depending on vtkFLUENTCFFReader) |
-t, --tui |
Browse the parsed settings in a terminal UI instead of printing them |
--solver |
Solver type, time, dimension, precision, turbulence model, energy, radiation, gravity, ... |
--mat [TYPE ...], --materials |
Material properties grouped by material type (fluid / solid); filters match a material type or a material name (e.g. --mat fluid, --mat air) |
--bd [TYPE ...], --boundary |
Boundary condition settings; filters match a boundary type (vi for velocity-inlet, whole word for single-word types) or a zone name (e.g. --bd vi wall po, --bd shadow) |
--interfaces |
Mesh interfaces settings |
--ne, --named-expressions |
Named expressions |
--cff, --custom-field-functions |
Custom field functions |
--units [KEYWORD ...] |
Show changed units (filtered by one or more keywords; empty means default SI units) |
--solution |
Solution methods and controls |
--rd, --report-definitions |
Report definitions |
--residuals |
Residual settings |
--monitorsets |
Monitor sets |
--plotsets |
Plot sets |
--convergencesets |
Convergence sets |
--cell, --cell-registers |
Cell registers settings |
--iter |
Iteration / time-step settings |
--surfaces |
Surfaces settings |
--mesh |
Graphics mesh settings |
--contours |
Graphics contours settings |
--vectors |
Graphics vectors settings |
--pathlines |
Graphics pathlines settings |
--xy-plot |
Graphics xy-plot settings |
--scene |
Graphics scene settings |
--parameters |
Input / output parameters |
--save |
Save the output to file_name.json (if file_name not specified, it is the same as input file) |
--plot [out|xy|dat] |
Plot a data file; without TYPE, infer from the file extension |
Multiple flags can be combined freely. Case settings flags (--solver, --mat, etc.) apply to .cas.h5 files only.
Examples
# Show all settings and save to JSON
cffview case.cas.h5 --save
# Show solver configuration and boundary conditions
cffview case.cas.h5 --solver --bd
# Visualise the mesh
cffview case.cas.h5 --plotmesh
cffview mesh.msh.h5
# Visualise the data
cffview case.cas.h5 --plotdata
# Check the Fluent version of file
cffview case.cas.h5 --version
# Extract raw Scheme strings for manual inspection
cffview case.cas.h5 --extract
TUI
cffview case.cas.h5 --tui
The parsed settings are shown in a terminal UI instead of being printed: the case structure as a tree on the left, the selected entry as 4-space JSON on the right. Keys are coloured by nesting level, and the detail panel's border title shows the path and key count of the current entry.
| Key | Action |
|---|---|
↑ / ↓ |
Move in the tree |
enter |
Select the entry: expands / collapses it when it has children, shows it on the right when it is a leaf |
space |
Expand or collapse the selected entry |
shift+← / shift+→ |
Go to the parent / first child |
shift+↑ / shift+↓ |
Previous / next sibling |
shift+space |
Expand or collapse all entries |
pageup / pagedown, home / end |
Scroll the focused pane |
d |
Toggle the dark / light theme |
q |
Quit |
Clicking an entry selects it, and toggles it as well when it has children; either pane can also be scrolled with the mouse wheel.
Demo
https://github.com/user-attachments/assets/7f97b559-87fa-4822-be9f-4e82b8c5cab6
License
1 maintainer
Metadata
1 maintainer
Release files for cffview 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cffview-0.6.1.tar.gz | 33.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cffview-0.6.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 67.7 kB
Release files / cffview-0.6.1.tar.gz
| Download URL | cffview-0.6.1.tar.gz |
|---|---|
| Size | 33.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9f8b11e6a7289d762312204a389412a546c4b36f013edfb7b2b490787d5d36b8
|
|
BLAKE2b-256 checksum How to use checksums |
2e0309d9bfdd3b1f24df38ecd7fb358385ca42628c24bd1cffa3e6caf03f826d
|
| 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 14, 2026.
Transparency logRelease files / cffview-0.6.1-py3-none-any.whl
| Download URL | cffview-0.6.1-py3-none-any.whl |
|---|---|
| Size | 33.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f3e30e9d1e8eb4cd81b23b26152314d5547c063a4c5a1eb027a828140ce14c77
|
|
BLAKE2b-256 checksum How to use checksums |
7b6bd52a04ab94161f201fac27e965e19766242932c618d9b9e52bd0b49b8388
|
| 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 14, 2026.
Transparency log
