fix: fix 'in_time' constraint with algorithms that don't use weather data + small clean-ups

Author: MartinPontius

WeatherRoutingTool/algorithms/routingalg.py

@@ -1,11 +1,12 @@
+import logging
 from datetime import datetime
 
-import matplotlib
 from astropy import units as u
 from geovectorslib import geod
-from matplotlib.figure import Figure
+from matplotlib import figure, pyplot
 
-from WeatherRoutingTool.constraints.constraints import *
+import WeatherRoutingTool.utils.formatting as form
+from WeatherRoutingTool.constraints.constraints import ConstraintsList
 from WeatherRoutingTool.routeparams import RouteParams
 from WeatherRoutingTool.ship.ship import Boat
 from WeatherRoutingTool.utils.graphics import get_figure_path
@@ -27,7 +28,7 @@ class RoutingAlg:
     gcr_course: float  # azimuthal angle of great circle route (0 - 360°)
     gcr_dist: float  # distance of great circle route
 
-    fig: matplotlib.figure
+    fig: figure.Figure
     route_ensemble: list
     figure_path: str
     map_ext: Map
@@ -48,7 +49,7 @@ def __init__(self, config):
         self.gcr_course = self.gcr_course * u.degree
 
         self.figure_path = get_figure_path()
-        plt.switch_backend("Agg")
+        pyplot.switch_backend("Agg")
 
         self.boat_speed = config.BOAT_SPEED
         if self.boat_speed is not None:

WeatherRoutingTool/config.py

@@ -66,8 +66,6 @@ class Config(BaseModel):
         'land_crossing_global_land_mask', 'land_crossing_polygons', 'seamarks',
         'water_depth', 'on_map', 'in_time', 'via_waypoints', 'status_error'
     ]]
-    # options: 'land_crossing_global_land_mask', 'land_crossing_polygons',
-    # 'seamarks','water_depth', 'on_map', 'in_time', 'via_waypoints', 'status_error'
 
     _DATA_MODE_DEPTH: str = PrivateAttr('from_file')  # options: 'automatic', 'from_file', 'odc', 'skip'
     _DATA_MODE_WEATHER: str = PrivateAttr('from_file')  # options: 'automatic', 'from_file', 'odc', 'skip'

WeatherRoutingTool/constraints/constraints.py

@@ -839,15 +839,15 @@ class StayOnMap(NegativeContraint):
 
     def __init__(self):
         NegativeContraint.__init__(self, "StayOnMap")
-        self.message += "leaving wheather map!"  # self.resource_type = 0
+        self.message += "leaving weather map!"  # self.resource_type = 0
 
     def constraint_on_point(self, lat, lon, time):
         # self.print_debug('checking point: ' + str(lat) + ',' + str(lon))
         is_on_map = ((lat > self.lat2) + (lat < self.lat1) + (lon > self.lon2) + (lon < self.lon1))
         return is_on_map
 
     def print_info(self):
-        logger.info(form.get_log_step("stay on wheather map", 1))
+        logger.info(form.get_log_step("stay on weather map", 1))
 
     def set_map(self, lat1, lon1, lat2, lon2):
         self.lat1 = lat1
@@ -866,7 +866,7 @@ class StayInTime(NegativeContraint):
 
     def __init__(self):
         NegativeContraint.__init__(self, "StayInTime")
-        self.message += "leaving wheather time frame!"  # self.resource_type = 0
+        self.message += "leaving weather time frame!"  # self.resource_type = 0
 
     def check_crossing(self, lat_start: np.ndarray, lon_start: np.ndarray, lat_end: np.ndarray, lon_end: np.ndarray,
                        time_start: np.ndarray = None):
@@ -899,7 +899,7 @@ def check_crossing(self, lat_start: np.ndarray, lon_start: np.ndarray, lat_end:
         return is_out_of_time
 
     def print_info(self):
-        logger.info(form.get_log_step("stay in wheather time frame", 1))
+        logger.info(form.get_log_step("stay in weather time frame", 1))
 
     def set_time(self, time_start, time_end):
         self.time_start = time_start

WeatherRoutingTool/execute_routing.py

@@ -1,4 +1,5 @@
 # import cProfile
+import logging
 
 import WeatherRoutingTool.utils.graphics as graphics
 from WeatherRoutingTool.ship.ship_factory import ShipFactory
@@ -8,6 +9,8 @@
 from WeatherRoutingTool.algorithms.routingalg_factory import RoutingAlgFactory
 from WeatherRoutingTool.utils.maps import Map
 
+logger = logging.getLogger('WRT.execute_routing')
+
 
 def merge_figures_to_gif(path, nof_figures):
     graphics.merge_figs(path, nof_figures)
@@ -42,7 +45,12 @@ def execute_routing(config, ship_config):
     # initialise weather
     wt = WeatherFactory.get_weather(config._DATA_MODE_WEATHER, windfile, departure_time, time_forecast, time_resolution,
                                     default_map)
-    time_frame = (wt.time_start, wt.time_end)
+    if config._DATA_MODE_WEATHER == "skip":
+        time_frame = None
+        if "in_time" in config.CONSTRAINTS_LIST:
+            logger.warning("No weather data used. Ignoring constraint 'in_time'.")
+    else:
+        time_frame = (wt.time_start, wt.time_end)
 
     # *******************************************
     # initialise boat