Modules

The modules defined here are commonly found in microgrids. Pass any combination of modules to Microgrid to define and run a microgrid.

Timeseries Modules

Modules that are temporal in nature.

GridModule(max_import, max_export, time_series)	An electrical grid module.
LoadModule(time_series[, forecaster, ...])	A renewable energy module.
RenewableModule(time_series[, raise_errors, ...])	A renewable energy module.

Non-temporal Modules

Modules that do not depend on an underlying timeseries.

BatteryModule(min_capacity, max_capacity, ...)	A battery module.
GensetModule(running_min_production, ...[, ...])	A genset/generator module.

Helper Module

A module that cleans up after all the other modules are deployed.

UnbalancedEnergyModule(raise_errors[, ...])

Module Functions

Battery Transition Models

Various battery transition models.

BatteryTransitionModel()	A simple battery transition model.
BiasedTransitionModel([true_efficiency, ...])
DecayTransitionModel([decay_rate])