Remove science components from framework

changelog.rst

@@ -1,3 +1,5 @@
+.. default-role:: obj
+
 v0.1.0
 ------
 
@@ -6,30 +8,38 @@ Released on 2021, ???.
 .. rubric:: API changes
 
 * add units requirement for component parameters and constants
-  (`#21 <https://github.com/hydro-jules/cm4twc/issues/21>`_)
+  (`#21 <https://github.com/cm4twc-org/cm4twc/issues/21>`_)
+* move `Component` and its subclasses from subpackage `components` to package root
+  (`#46 <https://github.com/cm4twc-org/cm4twc/pull/46>`_)
+* rename component class attributes `_flow_direction` and `_land_sea_mask` in
+  component definition to `_requires_flow_direction` and `_requires_land_sea_mask`,
+  respectively
+  (`#46 <https://github.com/cm4twc-org/cm4twc/pull/46>`_)
+* remove science components (Artemis and RFM) from framework
+  (`#45 <https://github.com/cm4twc-org/cm4twc/issues/45>`_)
 
 .. rubric:: Bug fixes
 
 * fix dump file update bug due to missing 'divisions' dimension
-  (`#32 <https://github.com/hydro-jules/cm4twc/issues/32>`_)
+  (`#32 <https://github.com/cm4twc-org/cm4twc/issues/32>`_)
 
 .. rubric:: Enhancements
 
 * add support for arrays for component parameters
-  (`#21 <https://github.com/hydro-jules/cm4twc/issues/21>`_)
+  (`#21 <https://github.com/cm4twc-org/cm4twc/issues/21>`_)
 * add support for multiple divisions for component states
-  (`#39 <https://github.com/hydro-jules/cm4twc/pull/39>`_)
+  (`#39 <https://github.com/cm4twc-org/cm4twc/pull/39>`_)
 * add support for customisable divisions for component states
-  (`#31 <https://github.com/hydro-jules/cm4twc/issues/31>`_)
+  (`#31 <https://github.com/cm4twc-org/cm4twc/issues/31>`_)
 * add time slice for I/O operations (user customisable)
-  (`#42 <https://github.com/hydro-jules/cm4twc/pull/42>`_)
+  (`#42 <https://github.com/cm4twc-org/cm4twc/pull/42>`_)
 * cache remapping weights at initialisation
   (`#44 <https://github.com/cm4twc-org/cm4twc/pull/44>`_)
 
 .. rubric:: Documentation
 
 * document 'divisions' for component states in preparation page
-  (`#35 <https://github.com/hydro-jules/cm4twc/issues/35>`_)
+  (`#35 <https://github.com/cm4twc-org/cm4twc/issues/35>`_)
 * move API reference page to doc tree root
 * move science repository page to doc tree root
 * add support page

cm4twc/__init__.py

@@ -7,7 +7,8 @@
 from .time import TimeDomain
 from .space import LatLonGrid, RotatedLatLonGrid, BritishNationalGrid
 from .data import DataSet
-from .components import (surfacelayer, subsurface, openwater,
-                         SurfaceLayerComponent, SubSurfaceComponent,
-                         OpenWaterComponent, DataComponent, NullComponent)
+from .component import (
+    SurfaceLayerComponent, SubSurfaceComponent, OpenWaterComponent,
+    DataComponent, NullComponent
+)
 from .settings import atol, rtol, decr, dtype_float

cm4twc/components/_utils/records.py → cm4twc/_utils/record.py

@@ -3,8 +3,8 @@
 from datetime import datetime, timedelta
 import cftime
 
-from ...time import TimeDomain
-from ...settings import dtype_float
+from ..time import TimeDomain
+from ..settings import dtype_float
 
 
 # dictionary of supported aggregation methods

cm4twc/components/_utils/states.py → cm4twc/_utils/state.py

@@ -3,7 +3,7 @@
 import cftime
 import numpy as np
 
-from ...settings import dtype_float
+from ..settings import dtype_float
 
 
 class State(object):

cm4twc/components/component.py → cm4twc/component.py

@@ -5,18 +5,22 @@
 import cf
 from cfunits import Units
 from numbers import Number
+from copy import deepcopy
+import yaml
 
-from ._utils.states import (State, create_states_dump, update_states_dump,
-                            load_states_dump)
-from ._utils.records import (StateRecord, OutwardRecord, OutputRecord,
-                             RecordStream)
-from ..time import TimeDomain
-from .. import space
-from ..space import SpaceDomain, Grid
-from ..data import (
+from ._utils.state import (
+    State, create_states_dump, update_states_dump, load_states_dump
+)
+from ._utils.record import (
+    StateRecord, OutwardRecord, OutputRecord, RecordStream
+)
+from .time import TimeDomain
+from . import space
+from .space import SpaceDomain, Grid
+from .data import (
     DataSet, Variable, StaticVariable, ClimatologicVariable, DynamicVariable
 )
-from ..settings import dtype_float, array_order
+from .settings import dtype_float, array_order
 
 
 class MetaComponent(abc.ABCMeta):
@@ -33,72 +37,103 @@ class MetaComponent(abc.ABCMeta):
     _states_info = None
     _outputs_info = None
     _solver_history = None
-    _land_sea_mask = None
-    _flow_direction = None
+    _requires_land_sea_mask = None
+    _requires_flow_direction = None
 
     @property
     def category(cls):
         return cls._category
 
     @property
     def inwards_info(cls):
-        return cls._inwards_info
+        return deepcopy(cls._inwards_info)
 
     @property
     def outwards_info(cls):
-        return cls._outwards_info
+        return deepcopy(cls._outwards_info)
 
     @property
-    def inputs_info(cls):
-        return cls._inputs_info
+    def inwards_metadata(cls):
+        if cls._inwards_info:
+            return yaml.dump(cls._inwards_info)
 
     @property
-    def parameters_info(cls):
-        return cls._parameters_info
+    def outwards_metadata(cls):
+        if cls._outwards_info:
+            return yaml.dump(cls._outwards_info)
 
     @property
-    def constants_info(cls):
-        return cls._constants_info
+    def inputs_metadata(cls):
+        if cls._inputs_info:
+            return yaml.dump(cls._inputs_info)
 
     @property
-    def states_info(cls):
-        return cls._states_info
+    def parameters_metadata(cls):
+        if cls._parameters_info:
+            return yaml.dump(cls._parameters_info)
 
     @property
-    def outputs_info(cls):
-        return cls._outputs_info
+    def constants_metadata(cls):
+        if cls._constants_info:
+            return yaml.dump(cls._constants_info)
 
     @property
-    def solver_history(cls):
-        return cls._solver_history
+    def states_metadata(cls):
+        if cls._states_info:
+            return yaml.dump(cls._states_info)
 
     @property
-    def flow_direction(cls):
-        return cls._flow_direction
+    def outputs_metadata(cls):
+        if cls._outputs_info:
+            return yaml.dump(cls._outputs_info)
 
     @property
-    def land_sea_mask(cls):
-        return cls._land_sea_mask
+    def solver_history(cls):
+        return cls._solver_history
+
+    def requires_flow_direction(cls):
+        return cls._requires_flow_direction
+
+    def requires_land_sea_mask(cls):
+        return cls._requires_land_sea_mask
 
     def __str__(cls):
-        info = [
+        info_a = [
             "\n".join(
-                (["    {}:".format(t.replace('_', ' '))]
+                (["    {}:".format(t.replace('_info', ' metadata'))]
                  + ["        {} [{}]".format(n, info['units'])
                     for n, info in getattr(cls, '_' + t).items()])
             )
-            for t in ['inwards_info', 'outwards_info', 'inputs_info',
-                      'parameters_info', 'constants_info', 'outputs_info',
-                      'states_info']
-            if getattr(cls, t)
+            for t in ['inwards_info', 'inputs_info']
+            if getattr(cls, '_' + t)
         ]
+
+        info_b = [
+            "\n".join(
+                (["    {}:".format(t.replace('_info', ' metadata'))]
+                 + ["        {} [{}]".format(n, info['units'])
+                    for n, info in getattr(cls, '_' + t).items()])
+            )
+            for t in ['parameters_info', 'constants_info', 'states_info',
+                      'outwards_info', 'outputs_info']
+            if getattr(cls, '_' + t)
+        ]
+
         return "\n".join(
             ["{}(".format(cls.__name__)]
             + ["    category: {}".format(getattr(cls, '_category'))]
-            + info
-            + ["    solver history: {}".format(getattr(cls, '_solver_history'))]
-            + ["    land sea mask: {}".format(getattr(cls, '_land_sea_mask'))]
-            + ["    flow direction: {}".format(getattr(cls, '_flow_direction'))]
+            + info_a
+            + [
+                "    requires land sea mask: {}".format(
+                    getattr(cls, '_requires_land_sea_mask')
+                )
+            ]
+            + [
+                "    requires flow direction: {}".format(
+                    getattr(cls, '_requires_flow_direction')
+                )
+            ]
+            + info_b
             + [")"]
         )
 
@@ -116,8 +151,8 @@ class Component(metaclass=MetaComponent):
     _states_info = {}
     _outputs_info = {}
     _solver_history = 1
-    _land_sea_mask = False
-    _flow_direction = False
+    _requires_land_sea_mask = False
+    _requires_flow_direction = False
 
     def __init__(self, saving_directory, timedomain, spacedomain,
                  dataset=None, parameters=None, constants=None, records=None,
@@ -544,7 +579,7 @@ def _check_spacedomain(self, spacedomain):
                 "for spacedomain".format(Grid.__name__)
             )
 
-        if self._land_sea_mask:
+        if self._requires_land_sea_mask:
             if spacedomain.land_sea_mask is None:
                 raise RuntimeError(
                     "'land_sea_mask' must be set in {} of {} "
@@ -553,7 +588,7 @@ def _check_spacedomain(self, spacedomain):
                                             self.__class__.__name__)
                 )
 
-        if self._flow_direction:
+        if self._requires_flow_direction:
             if spacedomain.flow_direction is None:
                 raise RuntimeError(
                     "'flow_direction' must be set in {} of {} "
@@ -840,12 +875,12 @@ def category(self):
     @property
     def inwards_info(self):
         """Return the incoming information expected by the `Component`."""
-        return self._inwards_info
+        return deepcopy(self._inwards_info)
 
     @property
     def outwards_info(self):
         """Return the outgoing information provided by the `Component`."""
-        return self._outwards_info
+        return deepcopy(self._outwards_info)
 
     @classmethod
     def from_config(cls, cfg):
@@ -899,7 +934,7 @@ def to_config(self):
                         # create a new file for it
                         filename = sep.join(
                             [self.saving_directory,
-                             '_'.join([self.identifier, self.category, name])
+                             '_'.join([self.identifier, self._category, name])
                              + ".nc"]
                         )
                         cf.write(original, filename)
@@ -921,7 +956,7 @@ def to_config(self):
                         # create a new file for it
                         filename = sep.join(
                             [self.saving_directory,
-                             '_'.join([self.identifier, self.category, name])
+                             '_'.join([self.identifier, self._category, name])
                              + ".nc"]
                         )
                         cf.write(original, filename)