microgrid.model package

Module contents

The model package defines all classes that are used to represent a microgrid and its devices. It mainly contains data and a few useful methods.

class microgrid.model.Grid(data)[source]
__init__(data)[source]

A microgrid is represented by its devices which are either loads, generators or storage devices, and additional information such as prices. The period duration of the simulation is also stored at this level, although it is more part of the configuration of the simulation.

Parameters:data – A json type dictionary containing a description of the microgrid.
base_purchase_price
get_non_flexible_device_names()[source]
Returns:The list of names of all non-flexible loads and generators for which there must be an entry in the data history
peak_price
period_duration
price_margin
purchase_price(energy_prices)[source]
Parameters:energy_prices – A list of energy prices (i.e. a time series), in EUR/MWh
Returns:The actual purchase price taking into account all components, in EUR/kWh
sale_price(energy_prices)[source]
Parameters:energy_prices – A list of energy prices (i.e. a time series), in EUR/MWh
Returns:The actual sale price taking into account all components, in EUR/kWh
class microgrid.model.Device(name)[source]

Bases: object

__init__(name)[source]

Base class for all devices.

Parameters:name – Name of the devices, used as a reference for access to realized data or forecasts
class microgrid.model.Generator(name, params)[source]

Bases: microgrid.model.device.Device

__init__(name, params)[source]
Parameters:
  • name – Cf. parent class
  • params – dictionary of params, must include a capacity value , a steerable flag, and a min_stable_generation value
class microgrid.model.Load(name, capacity)[source]

Bases: microgrid.model.device.Device

__init__(name, capacity)[source]
Parameters:
  • name – Cf. parent class
  • capacity – Max rated power of the load.
class microgrid.model.Storage(name, params)[source]

Bases: microgrid.model.device.Device

__init__(name, params)[source]
Parameters:
  • name – Cf. parent class
  • params – dictionary of params, must include a capacity value , a max_charge_rate value, a max_max_discharge_rate value, a charge_charge_efficiency value and a discharge_charge_efficiency value.