fix simulation command arguments

* all commands now take model registries, progress hook, args and kwargs
* remove layers mod and pgk attr from meta class, not used anymore
* add command layer name class attribute to Model - used to denote which class takes commands
* use _listify
* also fix layer declared in model as classes instead of strings in _initialize(), loop over values and make new value dictionary with __name__ and __module__
* add cmd_layer and commands properties
*

Author: mikofski

carousel/core/models.py

@@ -39,8 +39,6 @@ class attributes.
     """
     _path_attr = 'modelpath'
     _file_attr = 'modelfile'
-    _layers_mod_attr = 'layers_mod'
-    _layers_pkg_attr = 'layers_pkg'
     _layers_cls_attr = 'layer_cls_names'
 
     def __new__(mcs, name, bases, attr):
@@ -88,6 +86,8 @@ class Model(object):
     layers_mod = LAYERS_MOD
     #: package with layers module
     layers_pkg = LAYERS_PKG
+    #: simulation layer
+    cmd_layer_name = 'simulations'
 
     def __init__(self, modelfile=None):
         # check for modelfile in meta class, but use argument if not None
@@ -148,7 +148,7 @@ def _load(self, layer=None):
             self.model = _model
         else:
             # convert non-sequence to tuple
-            layers = layer if isinstance(layer, (list, tuple)) else (layer, )
+            layers = _listify(layer)
             # update/load layers
             for layer in layers:
                 self.model[layer] = _model[layer]
@@ -182,6 +182,26 @@ def _initialize(self):
             # from layers module get the layer's class definition
             layer_cls = getattr(mod, self.layer_cls_names[layer])  # class def
             self.layers[layer] = layer_cls  # add layer class def to model
+            # check if model layers are classes
+            src_value = {}  # layer value generated from source classes
+            for src in value:
+                # skip if not a source class
+                if isinstance(src, basestring):
+                    continue
+                # check if source has keyword arguments
+                try:
+                    src, kwargs = src
+                except TypeError:
+                    kwargs = {}  # no key work arguments
+                # generate layer value from source class
+                src_value[src.__name__] = {'module': src.__module__,
+                                           'package': None}
+                # update layer keyword arguments
+                src_value[src.__name__].update(kwargs)
+            # use layer values generated from source class
+            if src_value:
+                value = src_value
+                # FIXME: update model with dictionary, can't save
             # set layer attribute with model data
             setattr(self, layer, layer_cls(value))
         self._update()
@@ -285,9 +305,17 @@ def save(self, modelfile, layer=None):
 
     @property
     def registries(self):
-        return {('%s_reg' % layer): getattr(self, '%s' % layer).reg
+        return {layer: getattr(self, layer).reg
                 for layer in self.layers}
 
+    @property
+    def cmd_layer(self):
+        return getattr(self, self.cmd_layer_name, NotImplemented)
+
+    @property
+    def commands(self):
+        return self.cmd_layer.reg.commands
+
     def command(self, cmd, progress_hook=None, *args, **kwargs):
         """
         Execute a model command.
@@ -298,8 +326,7 @@ def command(self, cmd, progress_hook=None, *args, **kwargs):
         cmds = cmd.split(None, 1)  # split commands and simulations
         sim_names = cmds[1:]  # simulations
         if not sim_names:
-            sim_names = self.model['simulations'].iterkeys()
-        kwargs.update(self.registries, progress_hook=progress_hook)
+            sim_names = self.cmd_layer.reg.iterkeys()
         for sim_name in sim_names:
-            sim_cmd = getattr(self.simulations.reg[sim_name], cmd)
-            sim_cmd(*args, **kwargs)
+            sim_cmd = getattr(self.cmd_layer.reg[sim_name], cmd)
+            sim_cmd(self.registries, progress_hook=progress_hook, *args, **kwargs)

carousel/core/simulations.py

@@ -162,28 +162,28 @@ def index_iterator(self):
 
     # TODO: change start to run
 
-    def start(self, data_reg, formula_reg, out_reg, calc_reg,
-              progress_hook=None):
+    def start(self, registries, progress_hook=None):
         """
         Start the simulation from time zero.
 
-        :param data_reg: Data registry.
-        :type data_reg:
-            :class:`~carousel.core.data_sources.DataRegistry`
-        :param formula_reg: Formula registry.
-        :type formula_reg:
-            :class:`~carousel.core.formulas.FormulaRegistry`
-        :param out_reg: Outputs registry.
-        :type out_reg:
-            :class:`~carousel.core.outputs.OutputRegistry`
-        :param calc_reg: Calculation registry.
-        :type calc_reg:
-            :class:`~carousel.core.calculation.CalcRegistry`
+        :param registries: Model registries with layer parameters.
+        :type: dict
         :param progress_hook: A function that receives either a string or a
             list containing the index followed by tuples of the data or outputs
             names and values specified by ``write_fields`` in the simfile.
         :type progress_hook: function
+
+
+        The model registries should contain the following layer registries:
+        * :class:`~carousel.core.data_sources.DataRegistry`,
+        * :class:`~carousel.core.formulas.FormulaRegistry`,
+        * :class:`~carousel.core.outputs.OutputRegistry`,
+        * :class:`~carousel.core.calculation.CalcRegistry`
         """
+        data_reg = registries['data']
+        formula_reg = registries['formulas']
+        out_reg = registries['outputs']
+        calc_reg = registries['calculations']
         # initialize
         if not self.isinitialized:
             self.initialize(calc_reg)
@@ -338,7 +338,7 @@ def format_write(self, data_reg, out_reg, idx=None):
         out_args = [out_reg[f][:idx] for f in out_fields]
         return np.concatenate(data_args + out_args, axis=1)
 
-    def pause(self):
+    def pause(self, **_):
         """
         Pause the simulation. How is this different from stopping it? Maintain
         info sufficient to restart simulation. Sets ``is_paused`` to True.

carousel/tests/test_model.py

@@ -122,3 +122,4 @@ class PVPowerSAPM3(Model):
 if __name__ == '__main__':
     m1 = PVPowerSAPM1()
     m2 = PVPowerSAPM2()
+    m3 = PVPowerSAPM3()