pytuflow.CrossSections.section

pytuflow.CrossSections.section#

CrossSections.section(locations, data_types=None, time=-1, *args, **kwargs)#

Return the cross-section data for given location and cross-section type.

The returned dataframe uses a multi-index with the first level being the cross-section ID and the second level being the returned data from the cross-section.

Parameters:

  • locations (str or list[str]) – The cross-section ID(s) to return the data for.

  • data_types (str or list[str], optional) – The cross-section type(s) to return the data for.

  • time (TimeLike, optional) – The time to return the data for. Not used for cross-sections.

Returns:

DataFrame of cross-section data.

Return type:

pd.DataFrame

Examples

Return the cross-section data for a given location and cross-section type:

>>> xs.section('1d_xs_M14_C99')
   1d_xs_M14_C99
               x        z
0        0.00000  38.4567
1        1.16450  38.2227
2        6.74383  37.4142
3        6.74534  37.4140
4        7.58031  36.8805
...        ...        ...
24      40.88000  37.6529
25      41.44690  37.6526
26      42.39770  37.6635
27      43.05550  37.6766
28      44.40290  37.7324
Contents