v3.6.6 - Return result path from run_simulation

CHANGELOG

@@ -1,5 +1,9 @@
 # 3.6
 
+## 3.6.6
+
+* The return values of simulations are now the path to their result file.
+
 ## 3.6.5
 
 * Fixed a bug with the NEURON adapter transmitter map causing loss of spike transmission.

bsb/__init__.py

@@ -1,3 +1,3 @@
-__version__ = "3.6.5"
+__version__ = "3.6.6"
 
 from .reporting import set_verbosity, report, warn

bsb/core.py

@@ -388,14 +388,14 @@ def run_simulation(self, simulation_name, quit=False):
             listener = ReportListener(self, report_file)
             simulation.add_progress_listener(listener)
         simulation.simulate(simulator)
-        simulation.collect_output()
+        result_path = simulation.collect_output()
         time_sim = time.time() - t
         report("Simulation runtime: {}".format(time_sim), level=2)
         if quit and hasattr(simulator, "quit"):
             simulator.quit()
         time_sim = time.time() - t
         report("Simulation runtime: {}".format(time_sim), level=2)
-        return simulation
+        return result_path
 
     def get_simulation(self, simulation_name):
         """

bsb/simulators/nest.py

@@ -514,9 +514,10 @@ def collect_output(self):
             print(str(e))
             rank = 0
 
+        timestamp = str(time.time()).split(".")[0] + str(_randint())
+        result_path = "results_" + self.name + "_" + timestamp + ".hdf5"
         if rank == 0:
-            timestamp = str(time.time()).split(".")[0] + str(_randint())
-            with h5py.File("results_" + self.name + "_" + timestamp + ".hdf5", "a") as f:
+            with h5py.File(result_path, "a") as f:
                 for path, data, meta in self.result.safe_collect():
                     try:
                         path = "/".join(path)
@@ -542,6 +543,8 @@ def collect_output(self):
                                     path, "{} {}".format(data.dtype, data.shape)
                                 )
                             )
+        mpi4py.MPI.COMM_WORLD.bcast(result_path, root=0)
+        return result_path
 
     def validate(self):
         for cell_model in self.cell_models.values():

bsb/simulators/neuron/adapter.py

@@ -371,13 +371,12 @@ def collect_output(self):
 
         timestamp = str(time.time()).split(".")[0] + str(random.random()).split(".")[1]
         timestamp = self.pc.broadcast(timestamp)
+        result_path = "results_" + self.name + "_" + timestamp + ".hdf5"
         for node in range(self.scaffold.MPI.COMM_WORLD.size):
             self.pc.barrier()
             if node == self.pc_id:
                 report("Node", self.pc_id, "is writing", level=2, all_nodes=True)
-                with h5py.File(
-                    "results_" + self.name + "_" + timestamp + ".hdf5", "a"
-                ) as f:
+                with h5py.File(result_path, "a") as f:
                     for path, data, meta in self.result.safe_collect():
                         try:
                             path = "/".join(path)
@@ -403,6 +402,7 @@ def collect_output(self):
                                     )
                                 )
             self.pc.barrier()
+        return result_path
 
     def create_transmitters(self):
         # Concatenates all the `from` locations of all intersections together and creates