Class BatteryModule

src/pymgrid/modules/battery/battery_module.py:10–388

A battery module. Battery modules are fixed: when calling ``Microgrid.run``, you must pass a control for batteries. Parameters ---------- min_capacity : float Minimum energy that must be contained in the battery. max_capacity : float Maximum energy that ca

class BatteryModule(BaseMicrogridModule):
    """
    A battery module.

    Battery modules are fixed: when calling ``Microgrid.run``, you must pass a control for batteries.

    Parameters
    ----------
    min_capacity : float
        Minimum energy that must be contained in the battery.

    max_capacity : float
        Maximum energy that can be contained in the battery.
        If ``soc=1``, capacity is at this maximum.

    max_charge : float
        Maximum amount the battery can be charged in one step.

        .. warning::
            This amount is the maximum the battery can be charged internally, dependent on the
            ``battery_transition_model``. The amount the battery can be charged externally (e.g. the amount of
            energy the battery can absorb) is defined as the negative of :attr:`.min_act`.

    max_discharge : float
        Maximum amount the battery can be discharged in one step.

        .. warning::
            This amount is the maximum the battery can be discharged internally, dependent on the
            ``battery_transition_model``. The amount the battery can be discharged externally (e.g. the amount of
            energy the battery can provide) is defined as :attr:`.max_act`.

    efficiency : float
        Efficiency of the battery.
        See :meth:`BatteryModule.model_transition` for details.

    battery_cost_cycle : float, default 0.0
        Marginal cost of charging and discharging.

    battery_transition_model : callable or None, default None
        Function to model the battery's transition.
        If None, :class:`.BatteryTransitionModel` is used.

        .. note::
            If you define a battery_transition_model, it must be YAML-serializable if you plan to serialize
            your battery module or any microgrid containing your battery.

            For example, you can define it as a class with a ``__call__`` method and ``yaml.YAMLObject`` as its metaclass.
            See the `PyYAML documentation <https://pyyaml.org/wiki/PyYAMLDocumentation>`_ for details and
            :class:`.BatteryTransitionModel` for an example.

    init_charge : float or None, default None
        Initial charge of the battery.
        One of ``init_charge`` or ``init_soc`` must be passed, else an exception is raised.
        If both are passed, ``init_soc`` is ignored and ``init_charge`` is used.

    init_soc : float or None, default None
        Initial state of charge of the battery.
        One of ``init_charge`` or ``init_soc`` must be passed, else an exception is raised.