piel.tools.cocotb.data#

This file contains a range of functions used to read, plot and analyse cocotb simulations in a data-flow standard as suggested

Module Contents#

Functions#

get_simulation_output_files_from_design(design_directory)

This function returns a list of all the simulation output files in the design directory.

read_simulation_data(file_path)

This function returns a Pandas dataframe that contains all the simulation data outputted from the simulation run.

simple_plot_simulation_data(simulation_data)

Attributes#

get_simulation_output_files

get_simulation_output_files#
get_simulation_output_files_from_design(design_directory: piel.types.piel_path_types, extension: str = 'csv')[source]#

This function returns a list of all the simulation output files in the design directory.

Parameters:

design_directory (piel_path_types) – The path to the design directory.

Returns:

List of all the simulation output files in the design directory.

Return type:

output_files (list)

read_simulation_data(file_path: piel.types.piel_path_types)[source]#

This function returns a Pandas dataframe that contains all the simulation data outputted from the simulation run.

Parameters:

file_path (piel_path_types) – The path to the simulation data file.

Returns:

The simulation data in a Pandas dataframe.

Return type:

simulation_data (pd.DataFrame)

simple_plot_simulation_data(simulation_data: pandas.DataFrame)[source]#