Merge pull request #294 from carterbox/time-terminate

NEW: Stop reconstruction based on wall-time

src/tike/ptycho/ptycho.py

@@ -416,6 +416,13 @@ def iterate(self, num_iter: int) -> None:
         psi_previous = self.parameters.psi[0].copy()
         for i in range(num_iter):
 
+            if (
+                np.sum(self.parameters.algorithm_options.times)
+                > self.parameters.algorithm_options.time_limit
+            ):
+                logger.info("Maximum reconstruction time exceeded.")
+                break
+
             logger.info(f"{self.parameters.algorithm_options.name} epoch "
                         f"{len(self.parameters.algorithm_options.times):,d}")
 

src/tike/ptycho/solvers/options.py

@@ -72,6 +72,9 @@ class IterativeOptions(abc.ABC):
     """The number of epochs to consider for convergence monitoring. Set to
     any value less than 2 to disable."""
 
+    time_limit: float = np.inf
+    """Stop reconstruction when wall-time exceeds this number of seconds."""
+
 
 @dataclasses.dataclass
 class DmOptions(IterativeOptions):