Improve runtime reporting

Author: david-chapela

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "simod"
-version = "5.1.3"
+version = "5.1.4"
 authors = [
     "Ihar Suvorau <ihar.suvorau@gmail.com>",
     "David Chapela <david.chapela@ut.ee>",

src/simod/simod.py

@@ -405,5 +405,12 @@ def _export_runtimes(
         file_path: Path,
         runtimes: RuntimeMeter
 ):
-    with open(file_path, "w") as f:
-        json.dump(runtimes.runtimes, f)
+    with open(file_path, "w") as file:
+        json.dump(
+            runtimes.runtimes | {'explanation': f"Add '{RuntimeMeter.PREPROCESSING}' with '{RuntimeMeter.TOTAL}' "
+                                                f"for the runtime of the entire SIMOD pipeline and preprocessing "
+                                                f"stage. '{RuntimeMeter.EVALUATION}', if reported, should be left out "
+                                                f"as it measures the quality assessment of the final BPS model (i.e., "
+                                                f"it is not part of the discovery process."},
+            file
+        )