sdynpy.fileio.sdynpy_rattlesnake.read_transient_control_data

• Module: sdynpy.fileio.sdynpy_rattlesnake

• Source: GitHub

Signature¶

def sdynpy.fileio.sdynpy_rattlesnake.read_transient_control_data(file, coordinate_override_column=None)

Read transient control time-history data from a Rattlesnake nc4 file.

Reads the control response signal, specification signal, and drive signal time histories from the first non-channel environment group in file. Applies response and reference transformation matrices when present.

Parameters¶

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

• coordinate_override_column : str, optional Channel-table column whose string values are parsed as coordinates. When None (default) coordinates are built from node_number and node_direction. Note: this argument is currently overridden to None inside the function body regardless of the value passed.

Returns¶

• response_signal : TimeHistoryArray Measured control-response time history.

• spec_signal : TimeHistoryArray Specification (target) control signal time history.

• drive_signal : TimeHistoryArray Drive (output) signal time history.