File Info
FileInfo
FileInfo
dataclass
Structured metadata for a CFD data file.
get_info
get_info(fpath)
Extract metadata from a CFD data file.
Dispatches by file extension. For split formats (.s8/.s4), the companion .cd file is located automatically.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fpath
|
str | Path
|
Path to the data file. |
required |
Returns:
| Type | Description |
|---|---|
FileInfo
|
A |
FileInfo
|
timestep info, and format details. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If the file extension is not recognized. |
FileNotFoundError
|
If a required companion file is missing. |