Refactor Real Life Challenges simulator

src/virtualship/expedition/simulate_schedule.py

@@ -20,7 +20,7 @@
     Spacetime,
     Waypoint,
 )
-from virtualship.utils import _calc_sail_time
+from virtualship.utils import _calc_sail_time, _get_public_wp
 
 
 @dataclass
@@ -36,7 +36,7 @@ class ScheduleProblem:
     """Result of schedule that could not be fully completed."""
 
     time: datetime
-    failed_waypoint_i: int
+    failed_wp: int
 
 
 @dataclass
@@ -103,7 +103,7 @@ def __init__(self, projection: pyproj.Geod, expedition: Expedition) -> None:
         self._expedition = expedition
 
         assert self._expedition.schedule.waypoints[0].time is not None, (
-            "First waypoint must have a time. This should have been verified before calling this function."
+            "Departure port must have a time."
         )
         self._time = expedition.schedule.waypoints[0].time
         self._location = expedition.schedule.waypoints[0].location
@@ -122,9 +122,12 @@ def simulate(self) -> ScheduleOk | ScheduleProblem:
 
             # check if waypoint was reached in time
             # TODO: already tested in schedule.verify(), re-check here for robustness but could be removed if deemed redundant
+            #! TODO: however, schedule.verify() does not account for stationkeeping time, so move that to schedule.verify() as well
+            #! TODO: then can also address #249 properly with a depth/bathymetry lookup and enhanced messaging explaining that the schedule is infeasible due to stationkeeping time, not sailing time
             if waypoint.time is not None and self._time > waypoint.time:
+                public_wp = _get_public_wp(wp_i, self._expedition.schedule.waypoints)
                 print(
-                    f"\nWaypoint {wp_i + 1} could not be reached in time. Current time: {self._time}. Waypoint time: {waypoint.time}."
+                    f"\nWaypoint {public_wp} could not be reached in time. Current time: {self._time}. Waypoint time: {waypoint.time}."
                     "\n\nHave you ensured that your schedule includes sufficient time for taking measurements, e.g. CTD casts (in addition to the time it takes to sail between waypoints)?\n"
                 )
                 return ScheduleProblem(self._time, wp_i)

src/virtualship/instruments/base.py

@@ -26,9 +26,9 @@
     _find_files_in_timerange,
     _find_nc_file_with_variable,
     _get_bathy_data,
+    _get_clean_encoding,
     _get_waypoint_latlons,
     _select_product_id,
-    get_clean_encoding,
     ship_spinner,
 )
 
@@ -321,7 +321,7 @@ def _get_local_ds(self, files: list[Path]) -> xr.Dataset:
     @staticmethod
     def _via_tmp_ds(ds: xr.Dataset) -> xr.Dataset:
         """Create and re-load a temporary local dataset."""
-        encoding = get_clean_encoding(ds)
+        encoding = _get_clean_encoding(ds)
 
         with tempfile.TemporaryDirectory() as tmpdir:
             tmp_fpath = Path(tmpdir) / "tmp.nc"