pymgrid.modules.BatteryModule
=============================

.. currentmodule:: pymgrid.modules

.. autoclass:: BatteryModule

   

   
   .. rubric:: Methods

   .. autosummary::
      :toctree: generated/

   
       
       
          ~BatteryModule.as_sink
       
       
          ~BatteryModule.as_source
       
       
          ~BatteryModule.dump
       
       
          ~BatteryModule.dynamic_action_space
       
       
          ~BatteryModule.from_normalized
       
       
          ~BatteryModule.get_cost
       
       
          ~BatteryModule.load
       
       
          ~BatteryModule.log_dict
       
       
          ~BatteryModule.log_frame
       
       
          ~BatteryModule.model_transition
       
       
          ~BatteryModule.reset
       
       
          ~BatteryModule.sample_action
       
       
          ~BatteryModule.state_dict
       
       
          ~BatteryModule.step
       
       
          ~BatteryModule.to_normalized
       
       
          ~BatteryModule.transition_kwargs
       
       
          ~BatteryModule.update
       
       
          ~BatteryModule.verbose_eq
       
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
      :toctree: generated/

   
      ~BatteryModule.absorption_marginal_cost
      ~BatteryModule.action_space
      ~BatteryModule.battery_transition_model
      ~BatteryModule.current_charge
      ~BatteryModule.current_step
      ~BatteryModule.is_sink
      ~BatteryModule.is_source
      ~BatteryModule.log
      ~BatteryModule.logger
      ~BatteryModule.logger_last
      ~BatteryModule.marginal_cost
      ~BatteryModule.max_act
      ~BatteryModule.max_consumption
      ~BatteryModule.max_external_charge
      ~BatteryModule.max_external_discharge
      ~BatteryModule.max_obs
      ~BatteryModule.max_production
      ~BatteryModule.min_act
      ~BatteryModule.min_obs
      ~BatteryModule.min_production
      ~BatteryModule.module_type
      ~BatteryModule.observation_space
      ~BatteryModule.production_marginal_cost
      ~BatteryModule.soc
      ~BatteryModule.state
      ~BatteryModule.yaml_tag