Renames and docstrings

Author: domfournier

simpeg_drivers/driver.py

@@ -193,15 +193,15 @@ def validate_workers(self, workers: list[tuple[str]] | None) -> list[tuple[str]]
     @classmethod
     def start_dask_run(
         cls,
-        ifile,
+        json_path: Path,
         n_workers: int | None = None,
         n_threads: int | None = None,
         save_report: bool = True,
     ):
         """
         Sets Dask config settings.
 
-        :param ifile: Input file path.
+        :param json_path: Path to input file (.ui.json) for the application.
         :param n_workers: Number of Dask workers.
         :param n_threads: Number of threads per Dask worker.
         :param save_report: Whether to save a performance report.
@@ -229,18 +229,18 @@ def start_dask_run(
         ):
             # Full run
             with (
-                performance_report(filename=ifile.parent / "dask_profile.html")
+                performance_report(filename=json_path.parent / "dask_profile.html")
                 if (save_report and isinstance(context_client, Client))
                 else contextlib.nullcontext()
             ):
-                cls.start(ifile)
+                cls.start(json_path)
                 sys.stdout.close()
 
         profiler.disable()
 
         if save_report:
             with open(
-                ifile.parent / "runtime_profile.txt", encoding="utf-8", mode="w"
+                json_path.parent / "runtime_profile.txt", encoding="utf-8", mode="w"
             ) as s:
                 ps = pstats.Stats(profiler, stream=s)
                 ps.sort_stats("cumulative")

simpeg_drivers/plate_simulation/match/driver.py

@@ -44,7 +44,7 @@
 
 
 class PlateMatchDriver(BaseDriver):
-    """Sets up and manages workers to run all combinations of swepts parameters."""
+    """Sets up and manages workers to run all combinations of swept parameters."""
 
     _params_class = PlateMatchOptions
 
@@ -218,9 +218,9 @@ def run(self):
                 )
 
                 tasks.append(
-                    self.client.submit(process_files_batch, *args)
+                    self.client.submit(batch_files_score, *args)
                     if self.client
-                    else process_files_batch(*args)
+                    else batch_files_score(*args)
                 )
 
             # Display progress bar
@@ -312,9 +312,19 @@ def fetch_survey(workspace: Workspace) -> AirborneTEMReceivers | None:
     return None
 
 
-def process_files_batch(
+def batch_files_score(
     files: Path | list[Path], spatial_projection, time_projection, observed
-):
+) -> list[float]:
+    """
+    Process a batch of simulation files and compute scores against observed data.
+
+    :param files: Simulation file or list of simulation files to process.
+    :param spatial_projection: Spatial interpolation matrix.
+    :param time_projection: Time interpolation matrix.
+    :param observed: Observed data array.
+
+    :return: List of scores for each simulation file.
+    """
     scores = []
 
     if isinstance(files, Path):