Update 'area of interest' to 'space-time region' throughout

Author: VeckoTheGecko

src/virtualship/cli/_fetch.py

@@ -37,12 +37,11 @@ def hash_model(model: BaseModel, salt: int = 0) -> str:
     return create_hash(model.model_dump_json() + str(salt))
 
 
-def get_area_of_interest_hash(area_of_interest: SpaceTimeRegion) -> str:
-    """Get the hash of the area of interest."""
+def get_space_time_region_hash(space_time_region: SpaceTimeRegion) -> str:
     # Increment salt in the event of breaking data fetching changes with prior versions
     # of virtualship where you want to force new hashes (i.e., new data downloads)
     salt = 0
-    return hash_model(area_of_interest, salt=salt)
+    return hash_model(space_time_region, salt=salt)
 
 
 def filename_to_hash(filename: str) -> str:
@@ -83,7 +82,9 @@ def from_yaml(cls, file_path: str | Path) -> DownloadMetadata:
         return _generic_load_yaml(file_path, cls)
 
 
-def get_existing_download(data_folder: Path, aoi_hash: str) -> Path | None:
+def get_existing_download(
+    data_folder: Path, space_time_region_hash: str
+) -> Path | None:
     """Check if a download has already been completed. If so, return the path for existing download."""
     for download_path in data_folder.iterdir():
         try:
@@ -94,7 +95,7 @@ def get_existing_download(data_folder: Path, aoi_hash: str) -> Path | None:
             )
             continue
 
-        if hash == aoi_hash:
+        if hash == space_time_region_hash:
             assert_complete_download(download_path)
             return download_path
 

src/virtualship/cli/commands.py

@@ -11,8 +11,8 @@
     DOWNLOAD_METADATA,
     DownloadMetadata,
     complete_download,
-    get_area_of_interest_hash,
     get_existing_download,
+    get_space_time_region_hash,
     hash_to_filename,
 )
 from virtualship.expedition.do_expedition import _get_schedule, do_expedition
@@ -68,7 +68,7 @@ def init(path):
     default=None,
 )
 def fetch(path: str | Path, username: str | None, password: str | None) -> None:
-    """Entrypoint for the tool to download data based on area of interest."""
+    """Entrypoint for the tool to download data based on space-time region."""
     if sum([username is None, password is None]) == 1:
         raise ValueError("Both username and password must be provided when using CLI.")
 
@@ -79,31 +79,31 @@ def fetch(path: str | Path, username: str | None, password: str | None) -> None:
 
     schedule = _get_schedule(path)
 
-    if schedule.area_of_interest is None:
+    if schedule.space_time_region is None:
         raise ValueError(
-            "Area of interest not found in schedule, please define it to fetch the data."
+            "space_time_region not found in schedule, please define it to fetch the data."
         )
 
-    aoi_hash = get_area_of_interest_hash(schedule.area_of_interest)
+    space_time_region_hash = get_space_time_region_hash(schedule.space_time_region)
 
-    existing_download = get_existing_download(data_folder, aoi_hash)
+    existing_download = get_existing_download(data_folder, space_time_region_hash)
     if existing_download is not None:
         click.echo(
-            f"Data download for area of interest already completed ('{existing_download}')."
+            f"Data download for space-time region already completed ('{existing_download}')."
         )
         return
 
     creds_path = path / creds.CREDENTIALS_FILE
     username, password = creds.get_credentials_flow(username, password, creds_path)
 
-    # Extract area_of_interest details from the schedule
-    spatial_range = schedule.area_of_interest.spatial_range
-    time_range = schedule.area_of_interest.time_range
+    # Extract space_time_region details from the schedule
+    spatial_range = schedule.space_time_region.spatial_range
+    time_range = schedule.space_time_region.time_range
     start_datetime = time_range.start_time
     end_datetime = time_range.end_time
 
     # Create download folder and set download metadata
-    download_folder = data_folder / hash_to_filename(aoi_hash)
+    download_folder = data_folder / hash_to_filename(space_time_region_hash)
     download_folder.mkdir()
     DownloadMetadata(download_complete=False).to_yaml(
         download_folder / DOWNLOAD_METADATA
@@ -134,7 +134,7 @@ def fetch(path: str | Path, username: str | None, password: str | None) -> None:
         },
     }
 
-    # Iterate over all datasets and download each based on area_of_interest
+    # Iterate over all datasets and download each based on space_time_region
     try:
         for dataset in download_dict.values():
             copernicusmarine.subset(
@@ -160,7 +160,7 @@ def fetch(path: str | Path, username: str | None, password: str | None) -> None:
         raise e
 
     complete_download(download_folder)
-    click.echo("Data download based on area of interest completed.")
+    click.echo("Data download based on space-time region completed.")
 
 
 @click.command(help="Do the expedition.")

src/virtualship/expedition/do_expedition.py

@@ -6,7 +6,7 @@
 
 import pyproj
 
-from virtualship.cli._fetch import get_area_of_interest_hash, get_existing_download
+from virtualship.cli._fetch import get_existing_download, get_space_time_region_hash
 from virtualship.utils import CHECKPOINT, SCHEDULE, SHIP_CONFIG
 
 from .checkpoint import Checkpoint
@@ -139,8 +139,8 @@ def _load_input_data(
     :rtype: InputData
     """
     if input_data is None:
-        aoi_hash = get_area_of_interest_hash(schedule.area_of_interest)
-        input_data = get_existing_download(expedition_dir, aoi_hash)
+        space_time_region_hash = get_space_time_region_hash(schedule.space_time_region)
+        input_data = get_existing_download(expedition_dir, space_time_region_hash)
 
     return InputData.load(
         directory=input_data,

src/virtualship/expedition/schedule.py

@@ -15,7 +15,7 @@ class Schedule(pydantic.BaseModel):
     """Schedule of the virtual ship."""
 
     waypoints: list[Waypoint]
-    area_of_interest: SpaceTimeRegion | None = None
+    space_time_region: SpaceTimeRegion | None = None
 
     model_config = pydantic.ConfigDict(extra="forbid")
 

src/virtualship/expedition/space_time_region.py

@@ -12,7 +12,7 @@
 
 
 class SpatialRange(BaseModel):
-    """Defines the geographic boundaries for an area of interest."""
+    """Defines geographic boundaries."""
 
     minimum_longitude: Longitude
     maximum_longitude: Longitude
@@ -40,7 +40,7 @@ def _check_lon_lat_domain(self) -> Self:
 
 
 class TimeRange(BaseModel):
-    """Defines the temporal boundaries for an area of interest."""
+    """Defines the temporal boundaries for a space-time region."""
 
     start_time: datetime
     end_time: datetime
@@ -53,7 +53,7 @@ def _check_time_range(self) -> Self:
 
 
 class SpaceTimeRegion(BaseModel):
-    """An area of interest with spatial and temporal boundaries."""
+    """An space-time region with spatial and temporal boundaries."""
 
     spatial_range: SpatialRange
     time_range: TimeRange

src/virtualship/static/schedule.yaml

@@ -1,4 +1,4 @@
-area_of_interest:
+space_time_region:
   spatial_range:
     minimum_longitude: -5
     maximum_longitude: 5