pytuflow.HydTablesCheck

class HydTablesCheck(fpath)

Bases: TabularOutput

Class for reading the TUFLOW check file for 1D hydraulic tables. These are file that end with _1d_ta_tables_check.csv, found in the 1D check folder.

Parameters:

fpath (PathLike) – The path to the 1D hydraulic tables check file.

Raises:

ResultTypeError – Raises pytuflow.results.ResultTypeError if the file does not look like a HydTablesCheck file.

Examples

Load a 1D hydraulic tables check file:

>>> from pytuflow import HydTablesCheck
>>> hyd_tables = HydTablesCheck('path/to/1d_ta_tables_check.csv')

__init__(fpath)

Parameters:

fpath (Path | str)

Return type:

None

Methods

curtain	Not supported for HydTablesCheck results.
data_types	Returns all the available data types for the given filter.
ids	Returns all the available IDs for the given filter.
profile	Not supported for HydTablesCheck results.
section	Returns section data for the given locations and data types from the 1D tables check file.
time_series	Not supported for HydTablesCheck results.
times	HydraulicTableCheck1D results are static and will not return any times.

Attributes

ATTRIBUTE_TYPES
DOMAIN_TYPES
GEOMETRY_TYPES
ID_COLUMNS
fpath	The path to the source output file.
tcf	Path to the parent TCF file
cross_section_count	Number of cross-sections
channel_count	Number of channels
name	The result name
reference_time	The reference time for the output