Enhancements to SimulationTester and Main Function with Config Flexibility

[weihangzheng]

Enhancements to SimulationTester and Main Function with Config Flexibility

Description

This pull request introduces several enhancements to the SimulationTester class and the main function used in the simulation framework. The key changes are as follows:

1. SimulationTester Class Enhancements:

• Multiple Simulation Runs: Added functionality to run simulations multiple times and calculate an average convergence score. This is achieved through the new run_multiple_simulations method.
• Config File Flexibility: Introduced an optional config_file parameter in both the __init__ method and run_simulation method of the SimulationTester class. This allows users to specify a json file for the simulation, enhancing flexibility and customization of the simulation runs.
• Results Output: Updated the print_results method to not only print the simulation results to the console but also write them to a CSV file. This file is stored in a directory specified by config.simulation_dir.

2. Main Function Modification:

• Dynamic Config Import: Modified the main function to support dynamic import of the BaselineConfig class based on an optional config_file parameter. This change allows the function to adapt to different configuration needs, improving the usability of the simulation framework for various scenarios.

These enhancements aim to increase the versatility and user-friendliness of the simulation framework, providing more options for configuration and output handling.

Additional Notes

• Ensure that the directory structure and Python paths are correctly set up for these changes to function as intended.
• The updates assume that baseline_run and other dependent functions/modules are compatible with these enhancements.

[Thanoshan]

Heads up here, this looks like its cloning the Config module that we already have in NEPIADA. This isn't ideal, since if we add a config parameter to that file, we would have to make changes here to keep things in sync. Instead I would recommend importing the Config module, and setting the values in a function here, and return a "Config" type module as the return parameter.

[ArashAhmadian]

+1

[weihangzheng]

@Thanoshan I used json here addressed like you mentioned on Discord