Table Of Contents

inet.test.statistical

This module provides functionality for statistical testing of multiple simulations.

The main function is run_statistical_tests(). It allows running multiple statistical tests matching the provided filter criteria. Statistical tests check if scalar results of the simulations are the same as the saved baseline results. The baseline results can be found in the statistics folder of the simulation project. For the INET Framework the media folder can be found at https://github.com/inet-framework/statistics in a separate GitHub repository.

Classes

StatisticalResultsUpdateTask	Represents a self-contained operation that captures all necessary information in order to be run.
StatisticalTestTask	Represents a simulation test task that can be run (and re-run) without providing additional parameters.

Functions

get_statistical_test_tasks([sim_time_limit, run_number])	Returns multiple statistical test tasks matching the provided filter criteria. The returned tasks can be run by
get_update_statistical_result_tasks([run_number])	Returns multiple update statistical results tasks matching the provided filter criteria. The returned tasks can be run by
run_statistical_tests([append_args])	Runs one or more statistical tests that match the provided filter criteria.
update_statistical_results([sim_time_limit, append_args])	Updates the stored statistical results for one or more chart tests that match the provided filter criteria.

Module Contents

inet.test.statistical.get_statistical_test_tasks(sim_time_limit=get_statistical_test_sim_time_limit, run_number=0, **kwargs)

Returns multiple statistical test tasks matching the provided filter criteria. The returned tasks can be run by calling the run method.

Parameters:

kwargs (dict) – The filter criteria parameters are inherited from the get_simulation_tasks method.

Returns (MultipleTestTasks):

an object that contains a list of StatisticalTestTask objects matching the provided filter criteria. The result can be run (and re-run) without providing additional parameters.

inet.test.statistical.get_update_statistical_result_tasks(run_number=0, **kwargs)

Returns multiple update statistical results tasks matching the provided filter criteria. The returned tasks can be run by calling the run method.

Parameters:

kwargs (dict) – The filter criteria parameters are inherited from the get_simulation_tasks method.

Returns (MultipleUpdateTasks):

an object that contains a list of StatisticalResultsUpdateTask objects matching the provided filter criteria. The result can be run (and re-run) without providing additional parameters.

inet.test.statistical.run_statistical_tests(append_args=[], **kwargs)

Runs one or more statistical tests that match the provided filter criteria.

Parameters:

kwargs (dict) – The filter criteria parameters are inherited from the get_statistical_test_tasks() function.

Returns (MultipleSimulationTestTaskResults):

an object that contains a list of SimulationTestTaskResult objects. Each object describes the result of running one test task.

inet.test.statistical.update_statistical_results(sim_time_limit=get_statistical_test_sim_time_limit, append_args=[], **kwargs)

Updates the stored statistical results for one or more chart tests that match the provided filter criteria.

Parameters:

kwargs (dict) – The filter criteria parameters are inherited from the get_update_statistical_result_tasks() function.

Returns (MultipleUpdateTaskResults):

an object that contains a list of UpdateTaskResult objects. Each object describes the result of running one update task.

Table Of Contents

• inet.test.statistical
  • Classes
  • Functions
  • Module Contents
    • get_statistical_test_tasks()
    • get_update_statistical_result_tasks()
    • run_statistical_tests()
    • update_statistical_results()

Previous

inet.test.speed

Next

inet.test.statistical.StatisticalResultsUpdateTask