sdynpy.fileio.sdynpy_rattlesnake.read_rattlesnake_output

• Module: sdynpy.fileio.sdynpy_rattlesnake

• Source: GitHub

Signature¶

def sdynpy.fileio.sdynpy_rattlesnake.read_rattlesnake_output(file, coordinate_override_column=None, read_only_indices=None, read_variable='time_data', abscissa_start=None, abscissa_stop=None, downsample=None)

Reads in an nc4 Rattlesnake data file and returns the time history array as well as the channel table

Parameters¶

• file : str or netCDF4.Dataset Path to the nc4 file to read, or an already-open netCDF4.Dataset.

• coordinate_override_column : str, optional Name of a channel-table column whose string values are parsed as coordinates. When not specified, coordinates are assembled from the node_number and node_direction channel-table columns.

• read_only_indices : slice or iterable, optional A valid indexing operation to select which channel indices to read

• read_variable : str, optional The time variable from the Rattlesnake file to read. These will generally be time_data, time_data_1, time_data_2, etc. depending on how many streams exist in the file. The default is ‘time_data’.

• abscissa_start : float, optional Data will not be extracted for abscissa values less than this value

• abscissa_stop : float, optional Data will not be extracted for abscissa values greater than this value

• downsample : int, optional A step size to use to downsample the dataset when reading

Returns¶

• data_array : TimeHistoryArray Time history data in the Rattlesnake output file

• channel_table : DataFrame Pandas Dataframe containing the channel table information