Rename constants to forcings (#408)

Author: sandorkertesz

src/earthkit/data/sources/constants.py renamed to src/earthkit/data/sources/forcings.py

@@ -24,7 +24,7 @@
 LOG = logging.getLogger(__name__)
 
 
-class ConstantMetadata(RawMetadata):
+class ForcingMetadata(RawMetadata):
     LS_KEYS = ["valid_datetime", "param"]
 
     def __init__(self, d, geography):
@@ -42,7 +42,7 @@ def _valid_datetime(self):
         return datetime.datetime.fromisoformat(self["valid_datetime"])
 
 
-class ConstantMaker:
+class ForcingMaker:
     def __init__(self, field):
         self.field = field
         self.shape = self.field.shape
@@ -155,9 +155,6 @@ def sin_local_time(self, date):
         return np.sin(radians)
 
     def insolation(self, date):
-        # warn(
-        #     "The function `insolation` is deprecated, please use `cos_solar_zenith_angle` instead"
-        # )
         return self.cos_solar_zenith_angle(date)
 
     def toa_incident_solar_radiation(self, date):
@@ -216,7 +213,7 @@ def wrapper(date):
         return wrapper
 
 
-class ConstantField(Field):
+class ForcingField(Field):
     def __init__(self, maker, date, param, proc, number=None, array_backend=None):
         self.maker = maker
         self.date = date
@@ -235,7 +232,7 @@ def __init__(self, maker, date, param, proc, number=None, array_backend=None):
         )
         super().__init__(
             array_backend,
-            metadata=ConstantMetadata(d, self.maker.field.metadata().geography),
+            metadata=ForcingMetadata(d, self.maker.field.metadata().geography),
         )
 
     def _make_metadata(self):
@@ -248,7 +245,7 @@ def _values(self, dtype=None):
         return values
 
     def __repr__(self):
-        return "ConstantField(%s,%s,%s)" % (self.param, self.date, self.number)
+        return "ForcingField(%s,%s,%s)" % (self.param, self.date, self.number)
 
 
 def make_datetime(date, time):
@@ -287,7 +284,7 @@ def index_to_coords(index: int, shape):
     return result
 
 
-class ConstantsFieldListCore(FieldList):
+class ForcingsFieldListCore(FieldList):
     def __init__(self, source_or_dataset, request={}, **kwargs):
         request = dict(**request)
         request.update(kwargs)
@@ -317,7 +314,7 @@ def find_dates(source_or_dataset):
                     make_datetime(date, time)
                     for date, time in itertools.product(self.request["date"], self.request["time"])
                 ]
-                assert len(set(dates)) == len(dates), "Duplicates dates in constants."
+                assert len(set(dates)) == len(dates), "Duplicates dates in forcings."
                 return dates
 
             assert "date" not in self.request and "time" not in self.request
@@ -339,7 +336,7 @@ def find_dates(source_or_dataset):
         if not isinstance(self.numbers, (tuple, list)):
             self.numbers = [self.numbers]
 
-        self.maker = ConstantMaker(field=source_or_dataset[0])
+        self.maker = ForcingMaker(field=source_or_dataset[0])
         self.procs = {param: getattr(self.maker, param) for param in self.params}
         self._len = len(self.dates) * len(self.params) * len(self.numbers)
 
@@ -353,10 +350,10 @@ def _request(self, **request):
 
     @classmethod
     def new_mask_index(self, *args, **kwargs):
-        return ConstantsMaskFieldList(*args, **kwargs)
+        return ForcingsMaskFieldList(*args, **kwargs)
 
 
-class ConstantsFieldList(ConstantsFieldListCore):
+class ForcingsFieldList(ForcingsFieldListCore):
     def __len__(self):
         return self._len
 
@@ -375,7 +372,7 @@ def _getitem(self, n):
             param = self.params[param]
             number = self.numbers[number]
 
-            return ConstantField(
+            return ForcingField(
                 self.maker,
                 date,
                 param,
@@ -385,10 +382,10 @@ def _getitem(self, n):
             )
 
 
-class ConstantsMaskFieldList(ConstantsFieldListCore, MaskIndex):
+class ForcingsMaskFieldList(ForcingsFieldListCore, MaskIndex):
     def __init__(self, *args, **kwargs):
         MaskIndex.__init__(self, *args, **kwargs)
         FieldList._init_from_mask(self, self)
 
 
-source = ConstantsFieldList
+source = ForcingsFieldList

tests/data/constants/proc.yaml renamed to tests/data/forcings/proc.yaml

@@ -36,7 +36,7 @@
 ]
 
 
-def load_constants_fs(params=None, first_step=6, last_step=72):
+def load_forcings_fs(params=None, first_step=6, last_step=72):
     sample = from_source("file", earthkit_examples_file("test.grib"))
 
     if params is None:
@@ -58,7 +58,7 @@ def load_constants_fs(params=None, first_step=6, last_step=72):
         dates.append(start + datetime.timedelta(hours=step))
 
     ds = from_source(
-        "constants",
+        "forcings",
         sample,
         date=dates,
         param=params,

tests/constants/constants_fixtures.py renamed to tests/forcings/forcings_fixtures.py

@@ -15,11 +15,11 @@
 
 here = os.path.dirname(__file__)
 sys.path.insert(0, here)
-from constants_fixtures import load_constants_fs  # noqa: E402
+from forcings_fixtures import load_forcings_fs  # noqa: E402
 
 
-def test_constants_datetime():
-    ds, _ = load_constants_fs(last_step=12)
+def test_forcings_datetime():
+    ds, _ = load_forcings_fs(last_step=12)
 
     ref = {
         "base_time": [None],
@@ -32,8 +32,8 @@ def test_constants_datetime():
     assert ds.datetime() == ref
 
 
-def test_constants_valid_datetime():
-    ds, _ = load_constants_fs(last_step=12)
+def test_forcings_valid_datetime():
+    ds, _ = load_forcings_fs(last_step=12)
     f = ds[4]
 
     assert f.metadata("valid_datetime") == "2020-05-13T18:00:00"

tests/constants/test_constants_metadata.py renamed to tests/forcings/test_forcings_metadata.py

@@ -20,14 +20,14 @@
 
 here = os.path.dirname(__file__)
 sys.path.insert(0, here)
-from constants_fixtures import all_params  # noqa: E402
-from constants_fixtures import load_constants_fs  # noqa: E402
+from forcings_fixtures import all_params  # noqa: E402
+from forcings_fixtures import load_forcings_fs  # noqa: E402
 
 
 def _build_proc_ref():
     import yaml
 
-    ds, _ = load_constants_fs(params=all_params, last_step=12)
+    ds, _ = load_forcings_fs(params=all_params, last_step=12)
     d = {}
     for p in all_params:
         # print(f"p={p}")
@@ -44,11 +44,11 @@ def _build_proc_ref():
         yaml.dump(d, outfile, sort_keys=True)
 
 
-def test_constants_proc():
-    with open(earthkit_test_data_file(os.path.join("constants", "proc.yaml")), "r") as f:
+def test_forcings_proc():
+    with open(earthkit_test_data_file(os.path.join("forcings", "proc.yaml")), "r") as f:
         ref = yaml.safe_load(f)
 
-    ds, _ = load_constants_fs(params=all_params, last_step=12)
+    ds, _ = load_forcings_fs(params=all_params, last_step=12)
 
     for p in all_params:
         f = ds.sel(param=p, valid_datetime="2020-05-13T18:00:00")
@@ -61,8 +61,8 @@ def test_constants_proc():
 
 
 @pytest.mark.parametrize("param,coord", [("latitude", "lat"), ("longitude", "lon")])
-def test_constants_proc_latlon(param, coord):
-    ds, _ = load_constants_fs(params=all_params, last_step=12)
+def test_forcings_proc_latlon(param, coord):
+    ds, _ = load_forcings_fs(params=all_params, last_step=12)
 
     latlon = ds[0].to_latlon(flatten=True)
     coord = latlon[coord]

tests/constants/test_contants_proc.py renamed to tests/forcings/test_forcings_proc.py

@@ -17,7 +17,7 @@
 
 here = os.path.dirname(__file__)
 sys.path.insert(0, here)
-from constants_fixtures import load_constants_fs  # noqa: E402
+from forcings_fixtures import load_forcings_fs  # noqa: E402
 
 
 @pytest.mark.parametrize(
@@ -43,8 +43,8 @@
         (dict(INVALIDKEY="sin_logitude"), []),
     ],
 )
-def test_constants_sel_single_file_1(params, expected_meta):
-    ds, _ = load_constants_fs()
+def test_forcings_sel_single_file_1(params, expected_meta):
+    ds, _ = load_forcings_fs()
 
     g = ds.sel(**params)
     assert len(g) == len(expected_meta)
@@ -54,8 +54,8 @@ def test_constants_sel_single_file_1(params, expected_meta):
     return
 
 
-def test_constants_sel_single_file_as_dict():
-    ds, _ = load_constants_fs()
+def test_forcings_sel_single_file_as_dict():
+    ds, _ = load_forcings_fs()
 
     g = ds.sel(
         {

tests/constants/test_constants_sel.py renamed to tests/forcings/test_forcings_sel.py

@@ -17,19 +17,19 @@
 
 here = os.path.dirname(__file__)
 sys.path.insert(0, here)
-from constants_fixtures import load_constants_fs  # noqa: E402
+from forcings_fixtures import load_forcings_fs  # noqa: E402
 
 
-def test_constants_single_index_bad():
-    ds, _ = load_constants_fs()
+def test_forcings_single_index_bad():
+    ds, _ = load_forcings_fs()
     idx = len(ds) + 10
     with pytest.raises(IndexError):
         ds[idx]
 
 
 @pytest.mark.parametrize("index", [0, 2, 95, -1, -96])
-def test_constants_single_index(index):
-    ds, md = load_constants_fs()
+def test_forcings_single_index(index):
+    ds, md = load_forcings_fs()
     num = len(ds)
     r = ds[index]
 
@@ -54,8 +54,8 @@ def test_constants_single_index(index):
         slice(91, None),
     ],
 )
-def test_constants_slice(indexes):
-    ds, md = load_constants_fs()
+def test_forcings_slice(indexes):
+    ds, md = load_forcings_fs()
     num = len(ds)
     r = ds[indexes]
 
@@ -79,8 +79,8 @@ def test_constants_slice(indexes):
         ((1, 16, 5, 9), (1, 3)),
     ],
 )
-def test_constants_array_indexing(indexes1, indexes2):
-    ds, md = load_constants_fs()
+def test_forcings_array_indexing(indexes1, indexes2):
+    ds, md = load_forcings_fs()
 
     # first subset
     r = ds[indexes1]
@@ -106,14 +106,14 @@ def test_constants_array_indexing(indexes1, indexes2):
         ((1, 16, 5, 9), (1, 3)),
     ],
 )
-def test_constants_array_indexing_bad(indexes):
-    ds, _ = load_constants_fs()
+def test_forcings_array_indexing_bad(indexes):
+    ds, _ = load_forcings_fs()
     with pytest.raises(IndexError):
         ds[indexes]
 
 
-def test_constants_fieldlist_iterator():
-    ds, md = load_constants_fs()
+def test_forcings_fieldlist_iterator():
+    ds, md = load_forcings_fs()
     # sn = ds.metadata(["valid_datetime", "param"])
     sn = md
     assert len(sn) == len(ds)

tests/constants/test_constants_slice.py renamed to tests/forcings/test_forcings_slice.py

@@ -20,10 +20,10 @@
 
 here = os.path.dirname(__file__)
 sys.path.insert(0, here)
-from constants_fixtures import all_params  # noqa: E402
+from forcings_fixtures import all_params  # noqa: E402
 
 
-def test_constant_source_1():
+def test_forcings_source_1():
     sample = from_source("file", earthkit_examples_file("test.grib"))
 
     start = sample[0].datetime()["valid_time"]
@@ -37,7 +37,7 @@ def test_constant_source_1():
     params = all_params
 
     ds = from_source(
-        "constants",
+        "forcings",
         sample,
         date=dates,
         param=all_params,
@@ -53,7 +53,7 @@ def test_constant_source_1():
         assert f.metadata("param") == r[1]
 
 
-def test_constant_2():
+def test_forcings_2():
     sample = from_source("file", earthkit_examples_file("test.grib"))
 
     start = sample[0].datetime()["valid_time"]
@@ -69,7 +69,7 @@ def test_constant_2():
 
     ntimes = 4
     ds = from_source(
-        "constants",
+        "forcings",
         sample,
         date=dates,
         time=f"0/to/18/by/{24//ntimes}",
@@ -86,7 +86,7 @@ def test_constant_2():
         assert f.metadata("param") == r[1]
 
 
-def test_constant_3():
+def test_forcings_3():
     sample = from_source("file", earthkit_test_data_file("t_time_series.grib"))
 
     dates = [
@@ -100,7 +100,7 @@ def test_constant_3():
     params = all_params
 
     ds = from_source(
-        "constants",
+        "forcings",
         sample,
         param=params,
     )