Results

The results module provides the main interface for managing the simulation results. It contains a data class SimResult that encapsulates the performance metrics of a complete simulation run and a class SimResultManager that provides methods to save, load, and analyze the simulation results.

Documentation

class SimResult[source]

The results of a simulation.

sim_configs

The configuration settings of the simulation.

Type:

SimConfig

system_configs

The configuration settings of the system.

Type:

SystemConfig

simulation_results

The list of simulation results for each SNR point.

Type:

list[SingleSnrSimResult]

class SimResultManager[source]

The Simulation Result Manager.

This class is responsible for managing the simulation results. This includes saving, loading, displaying, plotting, etc.

search_results

Search for previously executed simulation results with the same simulation and system configuration.

load_results

Load simulation results from a previously executed simulation with the same simulation and system configuration.

save_results

Save the simulation results to a .npz file.

display

Display simulation results in a readable table format.

plot_system_performance

Plot the system performance.

plot_ut_performance

Plot the performance of each UT in the system.

plot_stream_performance

Plot the performance of each stream in the system.

plot_system_performance_comparison

Plot the system performance of multiple systems for comparison.

plot_ut_performance_comparison

Plot the user terminal performance of multiple systems for comparison.

See Also