sdynpy.fileio.sdynpy_rattlesnake.create_synthetic_test

• Module: sdynpy.fileio.sdynpy_rattlesnake

• Source: GitHub

Signature¶

def sdynpy.fileio.sdynpy_rattlesnake.create_synthetic_test(spreadsheet_file_name: 'str', system_filename: 'str', system: 'System', excitation_coordinates: 'CoordinateArray', response_coordinates: 'CoordinateArray', rattlesnake_directory: 'str', displacement_derivative=2, sample_rate: 'int' = None, time_per_read: 'float' = None, time_per_write: 'float' = None, integration_oversample: 'int' = 10, environments: 'list' = [], channel_comment_data: 'list' = None, channel_serial_number_data: 'list' = None, channel_triax_dof_data: 'list' = None, channel_engineering_unit_data: 'list' = None, channel_warning_level_data: 'list' = None, channel_abort_level_data: 'list' = None, channel_active_in_environment_data: 'dict' = None)

Create a Rattlesnake synthetic-test spreadsheet and save the system model.

Saves the structural dynamics system to system_filename, then uses the Rattlesnake components API to write a combined-environments profile template spreadsheet to spreadsheet_file_name. The channel table and hardware sheets are populated with the supplied coordinates, sample rate, and optional per-channel data.

Parameters¶

• spreadsheet_file_name : str Path (including filename) for the output Rattlesnake Excel spreadsheet.

• system_filename : str Path where the System object is saved before populating the sheet.

• system : System Structural dynamics system model to save.

• excitation_coordinates : CoordinateArray Coordinates for excitation (force/drive) channels.

• response_coordinates : CoordinateArray Coordinates for response (acceleration/measurement) channels.

• rattlesnake_directory : str Directory containing the Rattlesnake components Python package.

• displacement_derivative : int, optional Order of derivative used when mapping from displacement to the measured quantity (e.g. 2 for acceleration). Default is 2.

• sample_rate : int, optional Hardware sample rate in Hz written to the spreadsheet. Default is None (left blank).

• time_per_read : float, optional Acquisition frame duration in seconds. Default is None.

• time_per_write : float, optional Output frame duration in seconds. Default is None.

• integration_oversample : int, optional Integration oversample factor written to the Hardware sheet. Default is 10.

• environments : list of (str, str), optional List of (environment_type, environment_name) tuples describing the environments to include in the profile template. Default is [].

• channel_comment_data : list, optional Per-channel comment strings (column 4). Default is None.

• channel_serial_number_data : list, optional Per-channel serial number values (column 5). Default is None.

• channel_triax_dof_data : list, optional Per-channel triaxial DOF labels (column 6). Default is None.

• channel_engineering_unit_data : list, optional Per-channel engineering unit strings (column 8). Default is None.

• channel_warning_level_data : list, optional Per-channel warning level values (column 22). Default is None.

• channel_abort_level_data : list, optional Per-channel abort level values (column 23). Default is None.

• channel_active_in_environment_data : dict, optional Mapping of environment name to a boolean list indicating which channels are active in that environment. When None (default) all channels are marked active in every environment.