From 2af4be1387d5e62bb4487ad3079ca719a9d4114e Mon Sep 17 00:00:00 2001
From: thorbjoernl <thorbjorn.s.lundin@met.no>
Date: Wed, 29 May 2024 12:05:42 +0200
Subject: [PATCH] fix: Consistent station/region/location naming

---
 src/aerovaldb/aerovaldb.py                    | 38 ++++++++++---------
 src/aerovaldb/jsonfiledb.py                   | 10 ++---
 ...son => location-network-obsvar-layer.json} |  0
 ...son => location_network-obsvar_layer.json} |  0
 ...son => location_network-obsvar_layer.json} |  0
 tests/test_jsonfiledb.py                      | 18 +++------
 6 files changed, 32 insertions(+), 34 deletions(-)
 rename tests/test-db/json/project/experiment/hm/ts/{region-network-obsvar-layer.json => location-network-obsvar-layer.json} (100%)
 rename tests/test-db/json/project/experiment/ts/diurnal/{region_network-obsvar_layer.json => location_network-obsvar_layer.json} (100%)
 rename tests/test-db/json/project/experiment/ts/{region_network-obsvar_layer.json => location_network-obsvar_layer.json} (100%)

diff --git a/src/aerovaldb/aerovaldb.py b/src/aerovaldb/aerovaldb.py
index e8e6f76..7a42c6a 100644
--- a/src/aerovaldb/aerovaldb.py
+++ b/src/aerovaldb/aerovaldb.py
@@ -173,12 +173,12 @@ def put_contour(
         raise NotImplementedError
 
     @async_and_sync
-    @get_method("/v0/ts/{project}/{experiment}/{region}/{network}/{obsvar}/{layer}")
+    @get_method("/v0/ts/{project}/{experiment}/{location}/{network}/{obsvar}/{layer}")
     async def get_timeseries(
         self,
         project: str,
         experiment: str,
-        region: str,
+        location: str,
         network: str,
         obsvar: str,
         layer: str,
@@ -201,13 +201,13 @@ async def get_timeseries(
         """
         raise NotImplementedError
 
-    @put_method("/v0/ts/{project}/{experiment}/{region}/{network}/{obsvar}/{layer}")
+    @put_method("/v0/ts/{project}/{experiment}/{location}/{network}/{obsvar}/{layer}")
     def put_timeseries(
         self,
         obj,
         project: str,
         experiment: str,
-        region: str,
+        location: str,
         network: str,
         obsvar: str,
         layer: str,
@@ -233,13 +233,13 @@ def put_timeseries(
 
     @async_and_sync
     @get_method(
-        "/v0/ts_weekly/{project}/{experiment}/{station}_{network}-{obsvar}_{layer}"
+        "/v0/ts_weekly/{project}/{experiment}/{location}_{network}-{obsvar}_{layer}"
     )
     async def get_timeseries_weekly(
         self,
         project: str,
         experiment: str,
-        station: str,
+        location: str,
         network: str,
         obsvar: str,
         layer: str,
@@ -259,14 +259,14 @@ async def get_timeseries_weekly(
         raise NotImplementedError
 
     @put_method(
-        "/v0/ts_weekly/{project}/{experiment}/{station}_{network}-{obsvar}_{layer}"
+        "/v0/ts_weekly/{project}/{experiment}/{location}_{network}-{obsvar}_{layer}"
     )
     def put_timeseries_weekly(
         self,
         obj,
         project: str,
         experiment: str,
-        station: str,
+        location: str,
         network: str,
         obsvar: str,
         layer: str,
@@ -556,12 +556,12 @@ def put_scatter(
         raise NotImplementedError
 
     @async_and_sync
-    @get_method("/v0/profiles/{project}/{experiment}/{station}/{network}/{obsvar}")
+    @get_method("/v0/profiles/{project}/{experiment}/{location}/{network}/{obsvar}")
     async def get_profiles(
         self,
         project: str,
         experiment: str,
-        station: str,
+        location: str,
         network: str,
         obsvar: str,
         /,
@@ -577,13 +577,13 @@ async def get_profiles(
         """
         raise NotImplementedError
 
-    @put_method("/v0/profiles/{project}/{experiment}/{station}/{network}/{obsvar}")
+    @put_method("/v0/profiles/{project}/{experiment}/{location}/{network}/{obsvar}")
     def put_profiles(
         self,
         obj,
         project: str,
         experiment: str,
-        station: str,
+        location: str,
         network: str,
         obsvar: str,
         /,
@@ -607,7 +607,7 @@ async def get_heatmap_timeseries(
         project: str,
         experiment: str,
         /,
-        station: str = None,
+        region: str = None,
         network: str = None,
         obsvar: str = None,
         layer: str = None,
@@ -632,6 +632,10 @@ def put_heatmap_timeseries(
         project: str,
         experiment: str,
         /,
+        region: str = None,
+        network: str = None,
+        obsvar: str = None,
+        layer: str = None,
         *args,
         **kwargs,
     ):
@@ -649,13 +653,13 @@ def put_heatmap_timeseries(
 
     @async_and_sync
     @get_method(
-        "/v0/forecast/{project}/{experiment}/{station}/{network}/{obsvar}/{layer}"
+        "/v0/forecast/{project}/{experiment}/{region}/{network}/{obsvar}/{layer}"
     )
     async def get_forecast(
         self,
         project: str,
         experiment: str,
-        station: str,
+        region: str,
         network: str,
         obsvar: str,
         layer: str,
@@ -675,14 +679,14 @@ async def get_forecast(
         raise NotImplementedError
 
     @put_method(
-        "/v0/forecast/{project}/{experiment}/{station}/{network}/{obsvar}/{layer}"
+        "/v0/forecast/{project}/{experiment}/{region}/{network}/{obsvar}/{layer}"
     )
     def put_forecast(
         self,
         obj,
         project: str,
         experiment: str,
-        station: str,
+        region: str,
         network: str,
         obsvar: str,
         layer: str,
diff --git a/src/aerovaldb/jsonfiledb.py b/src/aerovaldb/jsonfiledb.py
index b2838d9..29e9be8 100644
--- a/src/aerovaldb/jsonfiledb.py
+++ b/src/aerovaldb/jsonfiledb.py
@@ -23,7 +23,7 @@ def __init__(self, basedir: str | Path):
         self.PATH_LOOKUP = {
             "/v0/glob_stats/{project}/{experiment}/{frequency}": "./{project}/{experiment}/hm/glob_stats_{frequency}.json",
             "/v0/contour/{project}/{experiment}/{obsvar}/{model}": "./{project}/{experiment}/contour/{obsvar}_{model}.geojson",
-            "/v0/ts/{project}/{experiment}/{region}/{network}/{obsvar}/{layer}": "./{project}/{experiment}/ts/{region}_{network}-{obsvar}_{layer}.json",
+            "/v0/ts/{project}/{experiment}/{location}/{network}/{obsvar}/{layer}": "./{project}/{experiment}/ts/{location}_{network}-{obsvar}_{layer}.json",
             "/v0/experiments/{project}": "./{project}/experiments.json",
             "/v0/config/{project}/{experiment}": "./{project}/{experiment}/cfg_{project}_{experiment}.json",
             "/v0/menu/{project}/{experiment}": "./{project}/{experiment}/menu.json",
@@ -38,18 +38,18 @@ def __init__(self, basedir: str | Path):
                 "./{project}/{experiment}/map/{network}-{obsvar}_{layer}_{model}-{modvar}_{time}.json",
                 "./{project}/{experiment}/map/{network}-{obsvar}_{layer}_{model}-{modvar}.json",
             ],
-            "/v0/ts_weekly/{project}/{experiment}/{station}_{network}-{obsvar}_{layer}": "./{project}/{experiment}/ts/diurnal/{station}_{network}-{obsvar}_{layer}.json",
+            "/v0/ts_weekly/{project}/{experiment}/{location}_{network}-{obsvar}_{layer}": "./{project}/{experiment}/ts/diurnal/{location}_{network}-{obsvar}_{layer}.json",
             "/v0/scat/{project}/{experiment}/{network}-{obsvar}_{layer}_{model}-{modvar}": [
                 "./{project}/{experiment}/scat/{network}-{obsvar}_{layer}_{model}-{modvar}_{time}.json",
                 "./{project}/{experiment}/scat/{network}-{obsvar}_{layer}_{model}-{modvar}.json",
             ],
-            "/v0/profiles/{project}/{experiment}/{station}/{network}/{obsvar}": "./{project}/{experiment}/profiles/{station}_{network}-{obsvar}.json",
+            "/v0/profiles/{project}/{experiment}/{location}/{network}/{obsvar}": "./{project}/{experiment}/profiles/{location}_{network}-{obsvar}.json",
             "/v0/hm_ts/{project}/{experiment}": [
-                "./{project}/{experiment}/hm/ts/{station}-{network}-{obsvar}-{layer}.json",
+                "./{project}/{experiment}/hm/ts/{location}-{network}-{obsvar}-{layer}.json",
                 "./{project}/{experiment}/hm/ts/{network}-{obsvar}-{layer}.json",
                 "./{project}/{experiment}/hm/ts/stats_ts.json",
             ],
-            "/v0/forecast/{project}/{experiment}/{station}/{network}/{obsvar}/{layer}": "./{project}/{experiment}/forecast/{station}_{network}-{obsvar}_{layer}.json",
+            "/v0/forecast/{project}/{experiment}/{region}/{network}/{obsvar}/{layer}": "./{project}/{experiment}/forecast/{region}_{network}-{obsvar}_{layer}.json",
             "/v0/gridded_map/{project}/{experiment}/{obsvar}/{model}": "./{project}/{experiment}/contour/{obsvar}_{model}.json",
             "/v0/report/{project}/{experiment}/{title}": "./reports/{project}/{experiment}/{title}.json",
         }
diff --git a/tests/test-db/json/project/experiment/hm/ts/region-network-obsvar-layer.json b/tests/test-db/json/project/experiment/hm/ts/location-network-obsvar-layer.json
similarity index 100%
rename from tests/test-db/json/project/experiment/hm/ts/region-network-obsvar-layer.json
rename to tests/test-db/json/project/experiment/hm/ts/location-network-obsvar-layer.json
diff --git a/tests/test-db/json/project/experiment/ts/diurnal/region_network-obsvar_layer.json b/tests/test-db/json/project/experiment/ts/diurnal/location_network-obsvar_layer.json
similarity index 100%
rename from tests/test-db/json/project/experiment/ts/diurnal/region_network-obsvar_layer.json
rename to tests/test-db/json/project/experiment/ts/diurnal/location_network-obsvar_layer.json
diff --git a/tests/test-db/json/project/experiment/ts/region_network-obsvar_layer.json b/tests/test-db/json/project/experiment/ts/location_network-obsvar_layer.json
similarity index 100%
rename from tests/test-db/json/project/experiment/ts/region_network-obsvar_layer.json
rename to tests/test-db/json/project/experiment/ts/location_network-obsvar_layer.json
diff --git a/tests/test_jsonfiledb.py b/tests/test_jsonfiledb.py
index d0b9704..8c68916 100644
--- a/tests/test_jsonfiledb.py
+++ b/tests/test_jsonfiledb.py
@@ -23,13 +23,13 @@
         ),
         (
             "get_timeseries",
-            ["project", "experiment", "region", "network", "obsvar", "layer"],
+            ["project", "experiment", "location", "network", "obsvar", "layer"],
             None,
             "./project/experiment/ts/",
         ),
         (
             "get_timeseries_weekly",
-            ["project", "experiment", "region", "network", "obsvar", "layer"],
+            ["project", "experiment", "location", "network", "obsvar", "layer"],
             None,
             "./project/experiment/ts/dirunal/",
         ),
@@ -58,12 +58,6 @@
             {"time": "time"},
             "./project/experiment/map/with_time",
         ),
-        (
-            "get_timeseries_weekly",
-            ["project", "experiment", "region", "network", "obsvar", "layer"],
-            None,
-            "./project/experiment/ts/dirunal/",
-        ),
         (
             "get_scatter",
             ["project", "experiment", "network", "obsvar", "layer", "model", "modvar"],
@@ -105,7 +99,7 @@
                 "network": "network",
                 "obsvar": "obsvar",
                 "layer": "layer",
-                "station": "region",
+                "location": "location",
             },
             "./project/experiment/hm/ts/",
         ),
@@ -179,12 +173,12 @@ async def test_file_does_not_exist():
         ("contour", ["project", "experiment", "obsvar", "model"], None),
         (
             "timeseries",
-            ["project", "experiment", "region", "network", "obsvar", "layer"],
+            ["project", "experiment", "location", "network", "obsvar", "layer"],
             None,
         ),
         (
             "timeseries_weekly",
-            ["project", "experiment", "station", "network", "obsvar", "layer"],
+            ["project", "experiment", "location", "network", "obsvar", "layer"],
             None,
         ),
         ("experiments", ["project"], None),
@@ -226,7 +220,7 @@ async def test_file_does_not_exist():
             "heatmap_timeseries",
             ["project", "experiment"],
             {
-                "station": "station",
+                "location": "location",
                 "network": "network",
                 "obsvar": "obsvar",
                 "layer": "layer",