Store simulation result file, return sim state from run

.github/scripts/expected_sim_outputs/prePEX_sim_result

@@ -0,0 +1,8 @@
+Temp Frequency Power Error
+-20.0 129.14071960566622 0.0001395742 0.0
+0.0 812.2849983145087 0.0002163278 -1.289346328120196
+20.0 3727.362793911874 0.0003084833 -1.9080802354611635
+40.0 13548.07391774937 0.0004135828 -2.0993054808917933
+60.0 40754.728669280674 0.0005294709 -1.8851615101510149
+80.0 104974.85274914966 0.0006544336 -1.289346328120189
+100.0 238490.28020938495 0.0007871839 -0.373947898303868

openfasoc/generators/common/simulation/__init__.py

@@ -19,7 +19,7 @@ def run_simulations(
 	sim_tool: str = "ngspice",
 	num_concurrent_sims: int = 4,
 	netlist_path: str = "netlist.sp"
-) -> int:
+):
 	"""Runs SPICE simulations.
 
     Generates configurations of all combinations of the given `parameters` and simulates each case. The testbench SPICE file, configuration parameters, and the output for each run are generated in the `simulation_dir/runs_dir` directory.
@@ -73,7 +73,7 @@ def run_simulations(
     - `num_concurrent_sims` (int = 4): The maximum number of concurrent simulations.
     - `netlist_path` (str = "netlist.sp"): Path to the SPICE netlist of the design to be simulated.
 
-    Returns (int): The number of simulations run.
+    Returns : A dictionary containing the number of ongoing (ideally 0), completed and failed simulations.
 	"""
 
 	runs_dir_path = path.join(simulation_dir, runs_dir)
@@ -94,11 +94,11 @@ def run_simulations(
 	print(f"Number of configurations: {config_number}")
 	print(f"Number of concurrent simulations: {num_concurrent_sims}")
 
-	_run_simulations(
+	sim_state = _run_simulations(
 		num_configs=config_number,
 		num_concurrent_sims=num_concurrent_sims,
 		sim_tool=sim_tool,
 		runs_dir_path=runs_dir_path
 	)
 
-	return config_number
+	return sim_state

openfasoc/generators/common/simulation/simulation_run.py

@@ -15,6 +15,7 @@
 from os import path
 from common.simulation.utils import _print_progress
 import time
+import json
 import threading
 import subprocess
 
@@ -33,6 +34,8 @@ def _run_simulations(
     - `num_concurrent_sims` (int): The maximum number of concurrent simulations.
     - `sim_tool` (str): Path to the directory in which the simulation runs will be generated.
     - `runs_dir_path` (str): Path to the directory in which the simulation runs will be generated.
+
+    Returns: `simulation_state`, the number of ongoing, completed and failed sims.
 	"""
 
 	simulation_state = {
@@ -66,8 +69,9 @@ def thread_on_exit(exit_status: int, state=simulation_state):
 
 		_print_progress(num_configs, simulation_state['completed_sims'], simulation_state['failed_sims'], start_time)
 		time.sleep(1)
-
+	
 	_print_progress(num_configs, simulation_state['completed_sims'], simulation_state['failed_sims'], start_time, end='\n')
+	return simulation_state
 
 def _run_config(
 	sim_tool: str,
@@ -148,4 +152,4 @@ def _threaded_run(
 	except:
 		return on_exit(1)
 
-	on_exit(0)
+	on_exit(0)

openfasoc/generators/temp-sense-gen/tools/simulation.py

@@ -57,7 +57,7 @@ def generate_runs(
 
         update_netlist(srcNetlist, dstNetlist, jsonConfig["simMode"])
 
-        num_simulations = run_simulations(
+        sim_state = run_simulations(
             parameters={
                 'temp': {'start': tempStart, 'end': tempStop, 'step': tempStep},
                 'model_file': model_file,
@@ -75,7 +75,7 @@ def generate_runs(
 
         # Calculating simulation results and error
         with open(os.path.join(runDirPath, 'sim_output'), 'w') as sim_output_file:
-            for i in range(num_simulations):
+            for i in range(sim_state["completed_sims"]):
                 log_file_path = os.path.join(runDirPath, f"{i + 1}", f"sim_{i + 1}.log")
                 sim_results = get_sim_results(open(log_file_path, "r").read())
 
@@ -86,6 +86,10 @@ def generate_runs(
                 error_data = calculate_sim_error(sim_output_lines=sim_output_file.readlines())
                 all_result_file.write("\n".join(error_data))
 
+        # dump final simulation state to log file called sim_state_file
+        with open(spiceDir + "/sim_state_file.txt", 'w') as sim_state_file:
+            json.dump(sim_state, sim_state_file)
+
     return runDirPath
 
 def matchNetlistCell(cell_instantiation):
@@ -169,4 +173,4 @@ def update_netlist(srcNetlist, dstNetlist, simMode):
 """
         netlist = netlist.replace(toplevel_pinout.split(" ", 2)[2], standardized_pinout)
     with open(dstNetlist, "w") as wf:
-        wf.write(netlist)
+        wf.write(netlist)

tests/common_api/test_simulation.py

@@ -60,7 +60,7 @@ def run_before_and_after_tests():
 		rmtree(RUNS_DIR)
 
 def test_simulations():
-	num_runs = run_simulations(
+	sim_state = run_simulations(
 		parameters=PARAMS,
 		platform = "",
 		simulation_dir = TEST_SIMULATION_DIR,
@@ -69,7 +69,7 @@ def test_simulations():
 	)
 
 	# Check if the correct number of configurations are generated
-	assert num_runs == EXPECTED_NUM_CONFIGS, "The number of runs does not match the expected number."
+	assert sim_state["completed_sims"] == EXPECTED_NUM_CONFIGS, "The number of runs does not match the expected number."
 	assert len(os.listdir(RUNS_DIR)) == EXPECTED_NUM_CONFIGS, "The number of generated configurations does not match the expected number."
 
 
@@ -99,4 +99,4 @@ def test_simulations():
 			irms_value = get_value(log_file_text, 'irms')
 
 			assert vrms_value != "NOT_FOUND", f"`vrms` value not found in the simulation output for config #{i}"
-			assert irms_value != "NOT_FOUND", f"`irms` value not found in the simulation output for config #{i}"
+			assert irms_value != "NOT_FOUND", f"`irms` value not found in the simulation output for config #{i}"