Skip to content

read_file

read_file(fpath, *, grid_file=None, it=1, orient=True)

Read a file, dispatching by extension.

Parameters:

Name Type Description Default
fpath str | Path

Path to the primary data file (flow file for split formats).

required
grid_file str | Path | None

Path to the grid file (required for split formats; ignored for HDF5).

None
it int

Timestep index, 1-based (split format only).

1
orient bool

If True (default), the returned dataset is reoriented to the canonical layout (j=0 wall, +i streamwise) using cfd_io.orient.canonicalize_dataset. Pass orient=False to keep the on-disk index ordering.

True

Returns:

Type Description
Dataset

Dataset containing grid, flow, and metadata.

Raises:

Type Description
ValueError

If the file extension is not recognized.

FileNotFoundError

If any required file is missing.