Method state_dict

src/pymgrid/microgrid/microgrid.py:739–773

State of the microgrid as a dict. Keys are module names and values are lists of state dicts for all modules with said name. Parameters ---------- normalized : bool, default False Whether to return a dict of normalized values. as_run_out

(self, normalized=False, as_run_output=False, _initial=None)

        return self._modules

    def state_dict(self, normalized=False, as_run_output=False, _initial=None):
        """
        State of the microgrid as a dict.

        Keys are module names and values are lists of state dicts for all modules with said name.

        Parameters
        ----------
        normalized : bool, default False
            Whether to return a dict of normalized values.

        as_run_output : bool, default False
            Whether to return output in the same format as the output of :meth:`Microgrid.run`.
            Inner values are numpy arrays and not dict in this case.

        _initial : dict or None
            Internal parameter, do not use.

        Returns
        -------
        state_dict : dict[str, list[dict]] or dict[str[list[np.ndarray]]]
            State of the microgrid as a nested dict.

        """
        def as_run_output_f(state_dict):
            if as_run_output:
                return np.array(list(state_dict.values()))
            return state_dict

        state_dict = _initial or dict()

        for name, modules in self._modules.iterdict():
            state_dict[name] = [as_run_output_f(module.state_dict(normalized=normalized)) for module in modules]

        return state_dict

    @property
    def log(self):