Add fetch command to download expedition data based on space_time_region from schedule.yaml

src/virtualship/cli/commands.py

@@ -1,9 +1,11 @@
+from datetime import datetime
 from pathlib import Path
 
 import click
+import copernicusmarine
 
 from virtualship import utils
-from virtualship.expedition.do_expedition import do_expedition
+from virtualship.expedition.do_expedition import _get_schedule, do_expedition
 from virtualship.utils import SCHEDULE, SHIP_CONFIG
 
 
@@ -45,9 +47,76 @@ def init(path):
     "path",
     type=click.Path(exists=True, file_okay=False, dir_okay=True, readable=True),
 )
-def fetch(path):
-    """Entrypoint for the tool."""
-    raise NotImplementedError("Not implemented yet.")
+def fetch(expedition_dir: str | Path) -> None:
+    """Entrypoint for the tool to download data based on area of interest."""
+    if isinstance(expedition_dir, str):
+        expedition_dir = Path(expedition_dir)
+
+    # Load schedule
+    schedule = _get_schedule(expedition_dir)
+    if schedule is None:
+        print("Error: Schedule file not found.")
+        return
+
+    # Extract area_of_interest details from the schedule
+    spatial_range = schedule.area_of_interest.spatial_range
+    time_range = schedule.area_of_interest.time_range
+    start_datetime = datetime.strptime(time_range.start_time, "%Y-%m-%d %H:%M:%S")
+    end_datetime = datetime.strptime(time_range.end_time, "%Y-%m-%d %H:%M:%S")
+
+    # Prompt for user credentials
+    username = input("username: ")
+    password = input("password: ")
+
+    # Define all datasets to download, including bathymetry
+    download_dict = {
+        "Bathymetry": {
+            "dataset_id": "cmems_mod_glo_phy_my_0.083deg_static",
+            "variables": ["deptho"],
+            "output_filename": "bathymetry.nc",
+            "force_dataset_part": "bathy",
+        },
+        "UVdata": {
+            "dataset_id": "cmems_mod_glo_phy-cur_anfc_0.083deg_PT6H-i",
+            "variables": ["uo", "vo"],
+            "output_filename": "default_uv.nc",
+        },
+        "Sdata": {
+            "dataset_id": "cmems_mod_glo_phy-so_anfc_0.083deg_PT6H-i",
+            "variables": ["so"],
+            "output_filename": "default_s.nc",
+        },
+        "Tdata": {
+            "dataset_id": "cmems_mod_glo_phy-thetao_anfc_0.083deg_PT6H-i",
+            "variables": ["thetao"],
+            "output_filename": "default_t.nc",
+        },
+    }
+
+    # Iterate over all datasets and download each based on area_of_interest
+    for dataset in download_dict.values():
+        copernicusmarine.subset(
+            dataset_id=dataset["dataset_id"],
+            variables=dataset["variables"],
+            minimum_longitude=spatial_range.min_longitude,
+            maximum_longitude=spatial_range.max_longitude,
+            minimum_latitude=spatial_range.min_latitude,
+            maximum_latitude=spatial_range.max_latitude,
+            start_datetime=start_datetime,
+            end_datetime=end_datetime,
+            minimum_depth=0.49402499198913574,
+            maximum_depth=5727.9169921875,
+            output_filename=dataset["output_filename"],
+            output_directory=expedition_dir,
+            username=username,
+            password=password,
+            force_download=True,
+            force_dataset_part=dataset.get(
+                "force_dataset_part"
+            ),  # Only used if specified in dataset
+        )
+
+    click.echo("Data download based on area of interest completed.")
 
 
 @click.command(help="Do the expedition.")

src/virtualship/expedition/__init__.py

@@ -1,5 +1,6 @@
 """Everything for simulating an expedition."""
 
+from .area_of_interest import AreaOfInterest
 from .do_expedition import do_expedition
 from .instrument_type import InstrumentType
 from .schedule import Schedule
@@ -23,6 +24,7 @@
     "ShipConfig",
     "ShipUnderwaterSTConfig",
     "Waypoint",
+    "AreaOfInterest",
     "do_expedition",
     "instruments",
 ]

src/virtualship/expedition/area_of_interest.py

@@ -0,0 +1,30 @@
+"""AreaOfInterest class."""
+
+from dataclasses import dataclass
+from datetime import datetime
+
+
+@dataclass
+class SpatialRange:
+    """Defines the geographic boundaries for an area of interest."""
+
+    minimum_longitude: float
+    maximum_longitude: float
+    minimum_latitude: float
+    maximum_latitude: float
+
+
+@dataclass
+class TimeRange:
+    """Defines the temporal boundaries for an area of interest."""
+
+    start_time: datetime
+    end_time: datetime
+
+
+@dataclass
+class AreaOfInterest:
+    """An area of interest with spatial and temporal boundaries."""
+
+    spatial_range: SpatialRange
+    time_range: TimeRange

src/virtualship/expedition/schedule.py

@@ -7,13 +7,15 @@
 import pydantic
 import yaml
 
+from .area_of_interest import AreaOfInterest
 from .waypoint import Waypoint
 
 
 class Schedule(pydantic.BaseModel):
     """Schedule of the virtual ship."""
 
     waypoints: list[Waypoint]
+    area_of_interest: AreaOfInterest
 
     model_config = pydantic.ConfigDict(extra="forbid")
 

src/virtualship/static/schedule.yaml

@@ -1,3 +1,12 @@
+area_of_interest:
+  spatial_range:
+    minimum_longitude: -5
+    maximum_longitude: 5
+    minimum_latitude: -5
+    maximum_latitude: 5
+  time_range:
+    start_time: 2023-01-01 00:00:00
+    end_time: 2023-02-01 00:00:00
 waypoints:
   - instrument: CTD
     location: