change to minutes

Author: peterdudfield

nowcasting_datamodel/read/read.py

@@ -212,7 +212,7 @@ def get_all_gsp_ids_latest_forecast(
     start_target_time: Optional[datetime] = None,
     preload_children: Optional[bool] = False,
     historic: bool = False,
-    forecast_horizon_hours: Optional[int] = None,
+    forecast_horizon_minutes: Optional[int] = None,
 ) -> List[ForecastSQL]:
     """
     Read forecasts
@@ -223,6 +223,9 @@ def get_all_gsp_ids_latest_forecast(
         Filter: forecast values target time should be larger than this datetime
     :param preload_children: Option to preload children. This is a speed up, if we need them.
     :param historic: Option to load historic values or not
+    :param forecast_horizon_minutes: Optional filter on forecast horizon. For example
+        forecast_horizon_minutes=120, means load the forecast than was made 2 hours before the
+        target time. Note this only works for non-historic data.
 
     return: List of forecasts objects from database
     """
@@ -236,7 +239,7 @@ def get_all_gsp_ids_latest_forecast(
         preload_children=preload_children,
         historic=historic,
         gsp_ids=list(range(0, N_GSP + 1)),
-        forecast_horizon_hours=forecast_horizon_hours,
+        forecast_horizon_minutes=forecast_horizon_minutes,
     )
 
 
@@ -246,7 +249,7 @@ def get_latest_forecast_for_gsps(
     start_target_time: Optional[datetime] = None,
     preload_children: Optional[bool] = False,
     historic: bool = False,
-    forecast_horizon_hours: Optional[int] = None,
+    forecast_horizon_minutes: Optional[int] = None,
     gsp_ids: List[int] = None,
 ):
     """
@@ -259,8 +262,8 @@ def get_latest_forecast_for_gsps(
     :param preload_children: Option to preload children. This is a speed up, if we need them.
     :param historic: Option to load historic values or not
     :param gsp_ids: Option to filter on gsps. If None, then only the lastest forecast is loaded.
-    :param forecast_horizon_hours: Optional filter on forecast horizon. For example
-        forecast_horizon_hours=2, means load the forecast than was made 2 hours before the
+    :param forecast_horizon_minutes: Optional filter on forecast horizon. For example
+        forecast_horizon_minutes=120, means load the forecast than was made 2 hours before the
         target time. Note this only works for non-historic data.
 
     return: List of forecasts objects from database
@@ -301,13 +304,13 @@ def get_latest_forecast_for_gsps(
 
     from sqlalchemy import text
 
-    if forecast_horizon_hours is not None:
+    if forecast_horizon_minutes is not None:
         assert historic is False, Exception(
             "Loading a forecast horizon only works on non latest data."
         )
         query = query.join(ForecastValueSQL).filter(
             ForecastValueSQL.target_time - ForecastValueSQL.created_utc
-            >= text(f"interval '{forecast_horizon_hours} hour'")
+            >= text(f"interval '{forecast_horizon_minutes} hour'")
         )
 
     query = query.join(LocationSQL)

tests/read/test_read_forecast.py

@@ -57,7 +57,7 @@ def test_get_latest_forecast_created_utc_gsp(db_session):
     db_session.add_all([f1, f2])
     db_session.commit()
 
-    f = get_latest_forecast_for_gsps(session=db_session, forecast_horizon_hours=2, gsp_ids=[1])
+    f = get_latest_forecast_for_gsps(session=db_session, forecast_horizon_minutes=120, gsp_ids=[1])
     assert len(f) == 1
     assert f[0].forecast_values[0].created_utc == datetime(2022, 1, 1, 10, tzinfo=timezone.utc)
     assert f[0].forecast_values[0].target_time == datetime(2022, 1, 1, 12, tzinfo=timezone.utc)