updating tests and better unexpected error handling

Author: j-atkins

src/virtualship/cli/_run.py

@@ -8,6 +8,7 @@
 
 import copernicusmarine
 
+from virtualship.errors import ProblemsError
 from virtualship.expedition.simulate_schedule import (
     MeasurementsToSimulate,
     ScheduleProblem,
@@ -168,12 +169,20 @@ def _run(
                 and problems["problem_class"][0].pre_departure
                 else f"\033[4mUp next\033[0m: {itype.name} measurements...\n"
             )
-
-            problem_simulator.execute(
-                problems,
-                instrument_type_validation=itype,
-                problems_dir=problems_dir,
-            )
+            try:
+                problem_simulator.execute(
+                    problems,
+                    instrument_type_validation=itype,
+                    problems_dir=problems_dir,
+                )
+
+            except Exception as e:
+                os.removedirs(problems_dir)  # clean up if fails
+                os.remove(expedition_dir.joinpath(CHECKPOINT))
+                raise ProblemsError(
+                    f"An error occurred while simulating problems: {e}. Please report this issue, with a description and the traceback, "
+                    "to the VirtualShip issue tracker at: https://github.com/OceanParcels/virtualship/issues"
+                ) from e
 
         # get measurements to simulate
         attr = MeasurementsToSimulate.get_attr_for_instrumenttype(itype)

src/virtualship/errors.py

@@ -52,7 +52,7 @@ class CopernicusCatalogueError(Exception):
     pass
 
 
-class ProblemEncountered(Exception):
-    """Error raised when a problem is encountered during simulation."""
+class ProblemsError(Exception):
+    """Error raised when simulation of problem(s) in expedition fails."""
 
     pass

src/virtualship/expedition/simulate_schedule.py

@@ -150,7 +150,6 @@ def _progress_time_traveling_towards(self, location: Location) -> None:
             self._projection,
         )
         end_time = self._time + time_to_reach
-
         # note all ADCP measurements
         if self._expedition.instruments_config.adcp_config is not None:
             location = self._location

src/virtualship/models/checkpoint.py

@@ -111,6 +111,7 @@ def verify(self, expedition: Expedition, problems_dir: Path) -> None:
 
                     # problem at a later waypoint: check new scheduled time exceeds sail time + delay duration + instrument deployment time (rather whole delay duration add-on, as there may be _some_ contingency time already scheduled)
                     else:
+                        breakpoint()
                         failed_waypoint = new_schedule.waypoints[self.failed_waypoint_i]
 
                         scheduled_time = failed_waypoint.time - problem_waypoint.time

src/virtualship/utils.py

@@ -616,7 +616,7 @@ def _calc_sail_time(
     distance_to_next_waypoint = geodinv[2]
     return (
         timedelta(seconds=distance_to_next_waypoint / ship_speed_meter_per_second),
-        geodinv,
+        geodinv[0],
         ship_speed_meter_per_second,
     )
 
@@ -650,7 +650,12 @@ def _calc_wp_stationkeeping_time(
     # get wp total stationkeeping time
     cumulative_stationkeeping_time = timedelta()
     for iconfig in wp_instrument_configs:
-        if both_ctd_and_bgc and iconfig.instrument_type == InstrumentType.CTD_BGC:
+        breakpoint()
+        if (
+            both_ctd_and_bgc
+            and iconfig.__class__.__name__
+            == INSTRUMENT_CONFIG_MAP[InstrumentType.CTD_BGC]
+        ):
             continue  # only need to add time cost once if both CTD and CTD_BGC are being taken; in reality they would be done on the same instrument
         if hasattr(iconfig, "stationkeeping_time"):
             cumulative_stationkeeping_time += iconfig.stationkeeping_time

tests/cli/test_run.py

@@ -53,7 +53,9 @@ def test_run(tmp_path, monkeypatch):
     fake_data_dir = tmp_path / "fake_data"
     fake_data_dir.mkdir()
 
-    _run(expedition_dir, from_data=fake_data_dir)
+    _run(
+        expedition_dir, prob_level=0, from_data=fake_data_dir
+    )  # problems turned off here
 
     results_dir = expedition_dir / "results"