Skip to main content

PyPI Python versions CI

中文

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.
  • Visualise mesh or data with PyVista.

Installation

PyPI

pip install cffview

From source

git clone https://github.com/preamer/cffview.git
cd cffview
pip install .

Usage

[!IMPORTANT] Only tested with Ansys Fluent 25R2!

cffview <file> [options]

Options

Option Description
--version Print the Fluent version of file
--extract Dump raw Scheme settings to general.scm and boundary.scm
--plotmesh Visualise the mesh interactively with PyVista
--plotdata Visualise the data interactively with PyVista (may not work, depending on vtkFLUENTCFFReader)
--solver Solver type, time, dimension, precision, turbulence model, energy, radiation, gravity, ...
--mat, --materials Material properties
--bd, --boundary Boundary condition settings
--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.

[!TIP] Long options can be abbreviated to any unambiguous prefix. For example, --inter works for --interfaces and --vec for --vectors. An ambiguous prefix (e.g. --so, which could match --solver or --solution) is rejected with an error.

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

Demo

https://github.com/user-attachments/assets/7f97b559-87fa-4822-be9f-4e82b8c5cab6

License

BSD-3-Clause

Release files for cffview 0.5.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cffview 0.5.2
File Size Uploaded
cffview-0.5.2.tar.gz 30.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cffview 0.5.2
File Interpreter ABI Platform
cffview-0.5.2-py3-none-any.whl Python 3 none any Details

Total release size: 60.1 kB

Release files / cffview-0.5.2.tar.gz

Download URL cffview-0.5.2.tar.gz
Size 30.1 kB
Tags Source
SHA-256 checksum
How to use checksums
44dab5f5c327e7d82cffb5a751d773b7dab6d619c575486786735ae700b6e06e
BLAKE2b-256 checksum
How to use checksums
2adf210565824c36fc0b4cd8f8754f37b1389e34f1e9208d303e9edfb328f53a
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 Sep 6, 2026.

Transparency log

Release files / cffview-0.5.2-py3-none-any.whl

Download URL cffview-0.5.2-py3-none-any.whl
Size 30.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b209c7c95572bb11799dcb30100ab2d7350670aa6607e487afcfac3a2eeafff7
BLAKE2b-256 checksum
How to use checksums
4bbfb9f8856edc56ebcd2d3d3bd9bd36268ef8ed1602a1a35e4b767d5fba0553
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 Sep 6, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.5.2 This release

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.3

13 release files

0.1.1

13 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page