pymgrid.Microgrid
=================

.. currentmodule:: pymgrid

.. autoclass:: Microgrid

   

   
   .. rubric:: Methods

   .. autosummary::
      :toctree: generated/

   
       
       
          ~Microgrid.compute_net_load
       
       
          ~Microgrid.deserialize
       
       
          ~Microgrid.dump
       
       
          ~Microgrid.from_nonmodular
       
       
          ~Microgrid.from_normalized
       
       
          ~Microgrid.from_scenario
       
       
          ~Microgrid.get_cost_info
       
       
          ~Microgrid.get_empty_action
       
       
          ~Microgrid.get_forecast_horizon
       
       
          ~Microgrid.get_log
       
       
          ~Microgrid.load
       
       
          ~Microgrid.reset
       
       
          ~Microgrid.run
       
       
          ~Microgrid.sample_action
       
       
          ~Microgrid.set_forecaster
       
       
          ~Microgrid.set_module_attrs
       
       
          ~Microgrid.state_dict
       
       
          ~Microgrid.state_series
       
       
          ~Microgrid.step
       
       
          ~Microgrid.to_nonmodular
       
       
          ~Microgrid.to_normalized
       
       
          ~Microgrid.verbose_eq
       
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
      :toctree: generated/

   
      ~Microgrid.controllable
      ~Microgrid.current_step
      ~Microgrid.final_step
      ~Microgrid.fixed
      ~Microgrid.flex
      ~Microgrid.initial_step
      ~Microgrid.log
      ~Microgrid.module_list
      ~Microgrid.modules
      ~Microgrid.n_modules
      ~Microgrid.yaml_tag