update _plan logic (+ more changes to expedition model) to handle lifetime in minutes

Author: j-atkins

src/virtualship/cli/_plan.py

@@ -138,15 +138,15 @@ def log_exception_to_file(
             {"name": "cycle_days"},
             {"name": "drift_days"},
             {"name": "stationkeeping_time", "minutes": True},
-            {"name": "lifetime", "minutes": True},
+            {"name": "lifetime", "days": True},
         ],
     },
     "drifter_config": {
         "class": DrifterConfig,
         "title": "Drifter",
         "attributes": [
             {"name": "depth_meter"},
-            {"name": "lifetime", "minutes": True},
+            {"name": "lifetime", "days": True},
             {"name": "stationkeeping_time", "minutes": True},
         ],
     },
@@ -264,7 +264,10 @@ def compose(self) -> ComposeResult:
                         with Container(classes="instrument-config"):
                             for attr_meta in attributes:
                                 attr = attr_meta["name"]
-                                is_minutes = attr_meta.get("minutes", False)
+                                is_minutes, is_days = (
+                                    attr_meta.get("minutes", False),
+                                    attr_meta.get("days", False),
+                                )
                                 validators = group_validators(config_class, attr)
                                 if config_instance:
                                     raw_value = getattr(config_instance, attr, "")
@@ -275,16 +278,23 @@ def compose(self) -> ComposeResult:
                                             )
                                         except AttributeError:
                                             value = str(raw_value)
+                                    elif is_days and raw_value != "":
+                                        try:
+                                            value = str(
+                                                raw_value.total_seconds() / 86400.0
+                                            )
+                                        except AttributeError:
+                                            value = str(raw_value)
                                     else:
                                         value = str(raw_value)
                                 else:
                                     value = ""
                                 label = f"{attr.replace('_', ' ').title()}:"
-                                yield Label(
-                                    label
-                                    if not is_minutes
-                                    else label.replace(":", " Minutes:")
-                                )
+                                if is_minutes:
+                                    label = label.replace(":", " Minutes:")
+                                elif is_days:
+                                    label = label.replace(":", " Days:")
+                                yield Label(label)
                                 yield Input(
                                     id=f"{instrument_name}_{attr}",
                                     type=type_to_textual(
@@ -392,11 +402,14 @@ def _update_instrument_configs(self):
             for attr_meta in attributes:
                 attr = attr_meta["name"]
                 is_minutes = attr_meta.get("minutes", False)
+                is_days = attr_meta.get("days", False)
                 input_id = f"{instrument_name}_{attr}"
                 value = self.query_one(f"#{input_id}").value
                 field_type = get_field_type(config_class, attr)
                 if is_minutes and field_type is datetime.timedelta:
                     value = datetime.timedelta(minutes=float(value))
+                elif is_days and field_type is datetime.timedelta:
+                    value = datetime.timedelta(days=float(value))
                 else:
                     value = field_type(value)
                 kwargs[attr] = value

src/virtualship/models/expedition.py

@@ -14,7 +14,7 @@
 from virtualship.utils import (
     _get_bathy_data,
     _get_waypoint_latlons,
-    _validate_numeric_mins_to_timedelta,
+    _validate_numeric_to_timedelta,
 )
 
 from .location import Location
@@ -227,19 +227,19 @@ class ArgoFloatConfig(pydantic.BaseModel):
 
     @pydantic.field_serializer("lifetime")
     def _serialize_lifetime(self, value: timedelta, _info):
-        return value.total_seconds() / 60.0
+        return value.total_seconds() / 86400.0  # [days]
 
     @pydantic.field_validator("lifetime", mode="before")
     def _validate_lifetime(cls, value: int | float | timedelta) -> timedelta:
-        return _validate_numeric_mins_to_timedelta(value)
+        return _validate_numeric_to_timedelta(value, "days")
 
     @pydantic.field_serializer("stationkeeping_time")
     def _serialize_stationkeeping_time(self, value: timedelta, _info):
         return value.total_seconds() / 60.0
 
     @pydantic.field_validator("stationkeeping_time", mode="before")
     def _validate_stationkeeping_time(cls, value: int | float | timedelta) -> timedelta:
-        return _validate_numeric_mins_to_timedelta(value)
+        return _validate_numeric_to_timedelta(value, "minutes")
 
     model_config = pydantic.ConfigDict(populate_by_name=True)
 
@@ -263,7 +263,7 @@ def _serialize_period(self, value: timedelta, _info):
 
     @pydantic.field_validator("period", mode="before")
     def _validate_period(cls, value: int | float | timedelta) -> timedelta:
-        return _validate_numeric_mins_to_timedelta(value)
+        return _validate_numeric_to_timedelta(value, "minutes")
 
 
 class CTDConfig(pydantic.BaseModel):
@@ -285,7 +285,7 @@ def _serialize_stationkeeping_time(self, value: timedelta, _info):
 
     @pydantic.field_validator("stationkeeping_time", mode="before")
     def _validate_stationkeeping_time(cls, value: int | float | timedelta) -> timedelta:
-        return _validate_numeric_mins_to_timedelta(value)
+        return _validate_numeric_to_timedelta(value, "minutes")
 
 
 class CTD_BGCConfig(pydantic.BaseModel):
@@ -307,7 +307,7 @@ def _serialize_stationkeeping_time(self, value: timedelta, _info):
 
     @pydantic.field_validator("stationkeeping_time", mode="before")
     def _validate_stationkeeping_time(cls, value: int | float | timedelta) -> timedelta:
-        return _validate_numeric_mins_to_timedelta(value)
+        return _validate_numeric_to_timedelta(value, "minutes")
 
 
 class ShipUnderwaterSTConfig(pydantic.BaseModel):
@@ -327,7 +327,7 @@ def _serialize_period(self, value: timedelta, _info):
 
     @pydantic.field_validator("period", mode="before")
     def _validate_period(cls, value: int | float | timedelta) -> timedelta:
-        return _validate_numeric_mins_to_timedelta(value)
+        return _validate_numeric_to_timedelta(value, "minutes")
 
 
 class DrifterConfig(pydantic.BaseModel):
@@ -349,19 +349,19 @@ class DrifterConfig(pydantic.BaseModel):
 
     @pydantic.field_serializer("lifetime")
     def _serialize_lifetime(self, value: timedelta, _info):
-        return value.total_seconds() / 60.0
+        return value.total_seconds() / 86400.0  # [days]
 
     @pydantic.field_validator("lifetime", mode="before")
     def _validate_lifetime(cls, value: int | float | timedelta) -> timedelta:
-        return _validate_numeric_mins_to_timedelta(value)
+        return _validate_numeric_to_timedelta(value, "days")
 
     @pydantic.field_serializer("stationkeeping_time")
     def _serialize_stationkeeping_time(self, value: timedelta, _info):
         return value.total_seconds() / 60.0
 
     @pydantic.field_validator("stationkeeping_time", mode="before")
     def _validate_stationkeeping_time(cls, value: int | float | timedelta) -> timedelta:
-        return _validate_numeric_mins_to_timedelta(value)
+        return _validate_numeric_to_timedelta(value, "minutes")
 
 
 class XBTConfig(pydantic.BaseModel):

src/virtualship/static/expedition.yaml

@@ -43,7 +43,7 @@ instruments_config:
     min_depth_meter: 0.0
     vertical_speed_meter_per_second: -0.1
     stationkeeping_time_minutes: 20.0
-    lifetime_days: 90720.0
+    lifetime_days: 63.0
   ctd_config:
     max_depth_meter: -2000.0
     min_depth_meter: -11.0
@@ -54,7 +54,7 @@ instruments_config:
     stationkeeping_time_minutes: 50.0
   drifter_config:
     depth_meter: -1.0
-    lifetime_days: 60480.0
+    lifetime_days: 42.0
     stationkeeping_time_minutes: 20.0
   xbt_config:
     max_depth_meter: -285.0

src/virtualship/utils.py

@@ -13,8 +13,8 @@
 import copernicusmarine
 import numpy as np
 import xarray as xr
-from parcels import FieldSet
 
+from parcels import FieldSet
 from virtualship.errors import CopernicusCatalogueError
 
 if TYPE_CHECKING:
@@ -186,11 +186,16 @@ def mfp_to_yaml(coordinates_file_path: str, yaml_output_path: str):  # noqa: D41
     expedition.to_yaml(yaml_output_path)
 
 
-def _validate_numeric_mins_to_timedelta(value: int | float | timedelta) -> timedelta:
-    """Convert minutes to timedelta when reading."""
+def _validate_numeric_to_timedelta(
+    value: int | float | timedelta, unit: str
+) -> timedelta:
+    """Convert to timedelta when reading."""
     if isinstance(value, timedelta):
         return value
-    return timedelta(minutes=value)
+    if unit == "minutes":
+        return timedelta(minutes=float(value))
+    elif unit == "days":
+        return timedelta(days=float(value))
 
 
 def _get_expedition(expedition_dir: Path) -> Expedition:

tests/expedition/expedition_dir/expedition.yaml

@@ -30,7 +30,7 @@ instruments_config:
     min_depth_meter: 0.0
     vertical_speed_meter_per_second: -0.1
     stationkeeping_time_minutes: 20.0
-    lifetime_days: 90720.0
+    lifetime_days: 63.0
   ctd_config:
     max_depth_meter: -2000.0
     min_depth_meter: -11.0
@@ -41,7 +41,7 @@ instruments_config:
     stationkeeping_time_minutes: 50.0
   drifter_config:
     depth_meter: -1.0
-    lifetime_days: 40320.0
+    lifetime_days: 28.0
     stationkeeping_time_minutes: 20.0
   ship_underwater_st_config:
     period_minutes: 5.0