pytuflow.HydTablesCheck.ids

pytuflow.HydTablesCheck.ids#

HydTablesCheck.ids(filter_by=None)#

Returns all the available IDs for the given filter.

The filter_by argument can be used to add a filter to the returned IDs. Available filters for the HydTablesCheck class are:

  • None - returns all IDs

Process step filters:

  • xs - returns the IDs that have raw cross-section data

  • processed - returns the IDs that have processed cross-section data

  • channel - returns the IDs for the processed channels

Type filters:

  • [type] - returns the IDs that match the given cross-section type (e.g. “XZ” or “HW”)

Data type filters:

  • [data type] - returns the IDs that match the given data type (e.g. “Storage Width”)

Combine filters:

  • [filter1]/[filter2] …: (use / to delim).

Parameters:

filter_by (str, optional) – The string to filter the IDs by.

Returns:

The available IDs.

Return type:

list[str]

Examples

Return all IDs for cross-section of type XZ:

>>> hyd_tables = HydTablesCheck('/path/to/1d_ta_tables_check.csv')
>>> hyd_tables.ids('xz')
['1d_xs_M14_C99', '1d_xs_M14_C100', '1d_xs_M14_C101'  ...  '1d_xs_M14_C102', '1d_xs_M14_C103', '1d_xs_M14_C104']

Return the name of the processed channels using the tabular data:

>>> hyd_tables.ids('channel')
['RD_weir', 'FC01.39', 'FC01.38'  ...  FC01.37', 'FC01.36', 'FC01.34']
Contents