update simulation, documentation and tests with revived ship_config

Author: j-atkins

docs/user-guide/quickstart.md

@@ -46,7 +46,7 @@ virtualship init EXPEDITION_NAME --from-mfp CoordinatesExport.xlsx
 The `CoordinatesExport.xlsx` in the `virtualship init` command refers to the .xlsx file exported from MFP. Replace the filename with the name of your exported .xlsx file (and make sure to move it from the Downloads to the folder/directory in which you are running the expedition).
 ```
 
-This will create a folder/directory called `EXPEDITION_NAME` with a single file: `expedition.yaml` containing details on the ship speed and instrument configurations, as well as the expedition schedule based on the sampling site coordinates that you specified in your MFP export. The `--from-mfp` flag indicates that the exported coordinates will be used.
+This will create a folder/directory called `EXPEDITION_NAME` with a single file: `expedition.yaml` containing details on the ship and instrument configurations, as well as the expedition schedule based on the sampling site coordinates that you specified in your MFP export. The `--from-mfp` flag indicates that the exported coordinates will be used.
 
 ```{note}
 For advanced users: it is also possible to run the expedition initialisation step without an MFP .xlsx export file. In this case you should simply run `virtualship init EXPEDITION_NAME` in the CLI. This will write an example `expedition.yaml` file in the `EXPEDITION_NAME` folder/directory. This file contains example waypoints, timings, instrument selections, and ship configuration, but can be edited or propagated through the rest of the workflow unedited to run a sample expedition.

src/virtualship/cli/_fetch.py

@@ -51,7 +51,7 @@ def _fetch(path: str | Path, username: str | None, password: str | None) -> None
     expedition = _get_expedition(path)
 
     expedition.schedule.verify(
-        expedition.ship_speed_knots,
+        expedition.ship_config.ship_speed_knots,
         input_data=None,
         check_space_time_region=True,
         ignore_missing_fieldsets=True,

src/virtualship/cli/_plan.py

@@ -38,6 +38,7 @@
     Expedition,
     InstrumentType,
     Location,
+    ShipConfig,
     ShipUnderwaterSTConfig,
     SpatialRange,
     TimeRange,
@@ -185,12 +186,12 @@ def compose(self) -> ComposeResult:
                 collapsed=False,
             ):
                 attr = "ship_speed_knots"
-                validators = group_validators(Expedition, attr)
+                validators = group_validators(ShipConfig, attr)
                 with Horizontal(classes="ship_speed"):
                     yield Label("[b]Ship Speed (knots):[/b]")
                     yield Input(
                         id="speed",
-                        type=type_to_textual(get_field_type(Expedition, attr)),
+                        type=type_to_textual(get_field_type(ShipConfig, attr)),
                         validators=[
                             Function(
                                 validator,
@@ -201,8 +202,8 @@ def compose(self) -> ComposeResult:
                         classes="ship_speed_input",
                         placeholder="knots",
                         value=str(
-                            self.expedition.ship_speed_knots
-                            if self.expedition.ship_speed_knots
+                            self.expedition.ship_config.ship_speed_knots
+                            if self.expedition.ship_config.ship_speed_knots
                             else ""
                         ),
                     )
@@ -542,16 +543,12 @@ def save_changes(self) -> bool:
 
     def _update_ship_speed(self):
         attr = "ship_speed_knots"
-        field_type = get_field_type(Expedition, attr)
+        field_type = get_field_type(type(self.expedition.ship_config), attr)
         value = field_type(self.query_one("#speed").value)
-        try:
-            if not (value > 0):
-                raise ValueError("ship_speed_knots must be greater than 0")
-        except TypeError:
-            raise UnexpectedError("Invalid ship speed value") from None
-
-        # persist to the Expedition instance
-        self.expedition.ship_speed_knots = value
+        ShipConfig.model_validate(
+            {**self.expedition.ship_config.model_dump(), attr: value}
+        )
+        self.expedition.ship_config.ship_speed_knots = value
 
     def _update_instrument_configs(self):
         for instrument_name, info in INSTRUMENT_FIELDS.items():

src/virtualship/expedition/do_expedition.py

@@ -60,7 +60,9 @@ def do_expedition(expedition_dir: str | Path, input_data: Path | None = None) ->
     print("\n---- WAYPOINT VERIFICATION ----")
 
     # verify schedule is valid
-    expedition.schedule.verify(expedition.ship_speed_knots, loaded_input_data)
+    expedition.schedule.verify(
+        expedition.ship_config.ship_speed_knots, loaded_input_data
+    )
 
     # simulate the schedule
     schedule_results = simulate_schedule(

src/virtualship/expedition/simulate_schedule.py

@@ -125,7 +125,9 @@ def _progress_time_traveling_towards(self, location: Location) -> None:
             lons2=location.lon,
             lats2=location.lat,
         )
-        ship_speed_meter_per_second = self._expedition.ship_speed_knots * 1852 / 3600
+        ship_speed_meter_per_second = (
+            self._expedition.ship_config.ship_speed_knots * 1852 / 3600
+        )
         azimuth1 = geodinv[0]
         distance_to_next_waypoint = geodinv[2]
         time_to_reach = timedelta(

src/virtualship/utils.py

@@ -114,7 +114,7 @@ def validate_coordinates(coordinates_data):
 
 def mfp_to_yaml(coordinates_file_path: str, yaml_output_path: str):  # noqa: D417
     """
-    Generates an expedition.yaml file with schedule information based on data from MFP excel file. The ship speed and instrument configurations entries in the YAML file are sourced from the static version.
+    Generates an expedition.yaml file with schedule information based on data from MFP excel file. The ship and instrument configurations entries in the YAML file are sourced from the static version.
 
     Parameters
     ----------
@@ -189,14 +189,14 @@ def mfp_to_yaml(coordinates_file_path: str, yaml_output_path: str):  # noqa: D41
         yaml.safe_load(get_example_expedition()).get("instruments_config")
     )
 
-    # extract ship speed from static
-    ship_speed_knots = yaml.safe_load(get_example_expedition()).get("ship_speed_knots")
+    # extract ship config from static
+    ship_config = yaml.safe_load(get_example_expedition()).get("ship_config")
 
     # combine to Expedition object
     expedition = Expedition(
         schedule=schedule,
         instruments_config=instruments_config,
-        ship_speed_knots=ship_speed_knots,
+        ship_config=ship_config,
     )
 
     # Save to YAML file

tests/cli/test_plan.py

@@ -106,7 +106,7 @@ async def test_UI_changes():
         with open(expedition_path) as f:
             saved_expedition = yaml.safe_load(f)
 
-        assert saved_expedition["ship_speed_knots"] == float(NEW_SPEED)
+        assert saved_expedition["ship_config"]["ship_speed_knots"] == float(NEW_SPEED)
 
         # check schedule.verify() methods are working by purposefully making invalid schedule (i.e. ship speed too slow to reach waypoints)
         invalid_speed = "0.0001"

tests/expedition/test_expedition.py

@@ -34,7 +34,7 @@ def test_import_export_expedition(tmpdir) -> None:
     expedition = Expedition(
         schedule=schedule,
         instruments_config=get_expedition.instruments_config,
-        ship_speed_knots=get_expedition.ship_speed_knots,
+        ship_config=get_expedition.ship_config,
     )
     expedition.to_yaml(out_path)
 
@@ -50,7 +50,7 @@ def test_verify_schedule() -> None:
         ]
     )
 
-    ship_speed_knots = _get_expedition(expedition_dir).ship_speed_knots
+    ship_speed_knots = _get_expedition(expedition_dir).ship_config.ship_speed_knots
 
     schedule.verify(ship_speed_knots, None)
 
@@ -158,7 +158,7 @@ def test_verify_schedule_errors(
 
     with pytest.raises(error, match=match):
         schedule.verify(
-            expedition.ship_speed_knots,
+            expedition.ship_config.ship_speed_knots,
             input_data,
             check_space_time_region=check_space_time_region,
         )

tests/expedition/test_simulate_schedule.py

@@ -16,7 +16,7 @@ def test_simulate_schedule_feasible() -> None:
 
     projection = pyproj.Geod(ellps="WGS84")
     expedition = Expedition.from_yaml("expedition_dir/expedition.yaml")
-    expedition.ship_speed_knots = 10.0
+    expedition.ship_config.ship_speed_knots = 10.0
     expedition.schedule = Schedule(
         waypoints=[
             Waypoint(location=Location(0, 0), time=base_time),
@@ -35,7 +35,7 @@ def test_simulate_schedule_too_far() -> None:
 
     projection = pyproj.Geod(ellps="WGS84")
     expedition = Expedition.from_yaml("expedition_dir/expedition.yaml")
-    expedition.ship_speed_knots = 10.0
+    expedition.ship_config.ship_speed_knots = 10.0
     expedition.schedule = Schedule(
         waypoints=[
             Waypoint(location=Location(0, 0), time=base_time),