cleanup run-stats plotter

dfm · Jul 30, 2023 · c8c0771 · c8c0771
1 parent 40ce8e7
commit c8c0771
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/..._atlas/notebook_controllers/controllers/toi_notebook_controller/toi_run_stats_recorder.py b/..._atlas/notebook_controllers/controllers/toi_notebook_controller/toi_run_stats_recorder.py
@@ -16,6 +16,12 @@
 
 
 class TOIRunStatsRecorder:
+    """Class to record the run stats of the TOI notebooks"""
+
+    # TODO: deprecate in place of the AnalysisSummary class
+    # (this makes each slurm job write to the same file)
+    # (AnalysisSummary makes each slurm job write to a different file)
+
     def __init__(self, fname: str):
         self.fname = os.path.abspath(fname)
         self.outdir = os.path.dirname(self.fname)