Skip to main content
Back to top
Ctrl
+
K
Site Navigation
Getting Started
Examples
API reference
GitHub
PyPI
Site Navigation
Getting Started
Examples
API reference
GitHub
PyPI
Section Navigation
Microgrid
pymgrid.Microgrid
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
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
Modules
pymgrid.modules.GridModule
GridModule.as_fixed
GridModule.as_flex
GridModule.as_sink
GridModule.as_source
GridModule.dump
GridModule.dynamic_action_space
GridModule.forecast
GridModule.from_normalized
GridModule.get_co2_cost
GridModule.get_co2_production
GridModule.get_cost
GridModule.load
GridModule.log_dict
GridModule.log_frame
GridModule.reset
GridModule.sample_action
GridModule.serializable_state_attributes
GridModule.serialize
GridModule.set_forecaster
GridModule.state_dict
GridModule.step
GridModule.to_normalized
GridModule.update
GridModule.verbose_eq
GridModule.absorption_marginal_cost
GridModule.action_space
GridModule.co2_per_kwh
GridModule.current_obs
GridModule.current_status
GridModule.current_step
GridModule.export_price
GridModule.final_step
GridModule.forecast_horizon
GridModule.forecaster
GridModule.forecaster_increase_uncertainty
GridModule.forecaster_relative_noise
GridModule.grid_status
GridModule.import_price
GridModule.is_sink
GridModule.is_source
GridModule.log
GridModule.logger
GridModule.logger_last
GridModule.marginal_cost
GridModule.max_act
GridModule.max_consumption
GridModule.max_obs
GridModule.max_production
GridModule.min_act
GridModule.min_obs
GridModule.min_production
GridModule.module_type
GridModule.observation_space
GridModule.production_marginal_cost
GridModule.state
GridModule.state_components
GridModule.time_series
GridModule.weak_grid
GridModule.yaml_tag
pymgrid.modules.LoadModule
LoadModule.as_sink
LoadModule.as_source
LoadModule.dump
LoadModule.dynamic_action_space
LoadModule.forecast
LoadModule.from_normalized
LoadModule.load
LoadModule.log_dict
LoadModule.log_frame
LoadModule.reset
LoadModule.sample_action
LoadModule.serializable_state_attributes
LoadModule.serialize
LoadModule.set_forecaster
LoadModule.state_dict
LoadModule.step
LoadModule.to_normalized
LoadModule.update
LoadModule.verbose_eq
LoadModule.absorption_marginal_cost
LoadModule.action_space
LoadModule.current_load
LoadModule.current_obs
LoadModule.current_step
LoadModule.final_step
LoadModule.forecast_horizon
LoadModule.forecaster
LoadModule.forecaster_increase_uncertainty
LoadModule.forecaster_relative_noise
LoadModule.is_sink
LoadModule.is_source
LoadModule.log
LoadModule.logger
LoadModule.logger_last
LoadModule.marginal_cost
LoadModule.max_act
LoadModule.max_consumption
LoadModule.max_obs
LoadModule.max_production
LoadModule.min_act
LoadModule.min_obs
LoadModule.min_production
LoadModule.module_type
LoadModule.observation_space
LoadModule.production_marginal_cost
LoadModule.state
LoadModule.state_components
LoadModule.time_series
LoadModule.yaml_tag
pymgrid.modules.RenewableModule
RenewableModule.as_sink
RenewableModule.as_source
RenewableModule.dump
RenewableModule.dynamic_action_space
RenewableModule.forecast
RenewableModule.from_normalized
RenewableModule.load
RenewableModule.log_dict
RenewableModule.log_frame
RenewableModule.reset
RenewableModule.sample_action
RenewableModule.serializable_state_attributes
RenewableModule.serialize
RenewableModule.set_forecaster
RenewableModule.state_dict
RenewableModule.step
RenewableModule.to_normalized
RenewableModule.update
RenewableModule.verbose_eq
RenewableModule.absorption_marginal_cost
RenewableModule.action_space
RenewableModule.current_obs
RenewableModule.current_renewable
RenewableModule.current_step
RenewableModule.final_step
RenewableModule.forecast_horizon
RenewableModule.forecaster
RenewableModule.forecaster_increase_uncertainty
RenewableModule.forecaster_relative_noise
RenewableModule.is_sink
RenewableModule.is_source
RenewableModule.log
RenewableModule.logger
RenewableModule.logger_last
RenewableModule.marginal_cost
RenewableModule.max_act
RenewableModule.max_consumption
RenewableModule.max_obs
RenewableModule.max_production
RenewableModule.min_act
RenewableModule.min_obs
RenewableModule.min_production
RenewableModule.module_type
RenewableModule.observation_space
RenewableModule.production_marginal_cost
RenewableModule.state
RenewableModule.state_components
RenewableModule.time_series
RenewableModule.yaml_tag
pymgrid.modules.BatteryModule
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
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
pymgrid.modules.GensetModule
GensetModule.as_sink
GensetModule.as_source
GensetModule.dump
GensetModule.dynamic_action_space
GensetModule.from_normalized
GensetModule.get_co2
GensetModule.get_co2_cost
GensetModule.get_cost
GensetModule.load
GensetModule.log_dict
GensetModule.log_frame
GensetModule.next_max_production
GensetModule.next_min_production
GensetModule.next_status
GensetModule.reset
GensetModule.sample_action
GensetModule.serializable_state_attributes
GensetModule.state_dict
GensetModule.step
GensetModule.to_normalized
GensetModule.update
GensetModule.update_status
GensetModule.verbose_eq
GensetModule.absorption_marginal_cost
GensetModule.action_space
GensetModule.current_status
GensetModule.current_step
GensetModule.goal_status
GensetModule.is_sink
GensetModule.is_source
GensetModule.log
GensetModule.logger
GensetModule.logger_last
GensetModule.marginal_cost
GensetModule.max_act
GensetModule.max_consumption
GensetModule.max_obs
GensetModule.max_production
GensetModule.min_act
GensetModule.min_obs
GensetModule.min_production
GensetModule.module_type
GensetModule.observation_space
GensetModule.production_marginal_cost
GensetModule.state
GensetModule.yaml_tag
pymgrid.modules.UnbalancedEnergyModule
UnbalancedEnergyModule.as_sink
UnbalancedEnergyModule.as_source
UnbalancedEnergyModule.dump
UnbalancedEnergyModule.dynamic_action_space
UnbalancedEnergyModule.from_normalized
UnbalancedEnergyModule.get_cost
UnbalancedEnergyModule.load
UnbalancedEnergyModule.log_dict
UnbalancedEnergyModule.log_frame
UnbalancedEnergyModule.reset
UnbalancedEnergyModule.sample_action
UnbalancedEnergyModule.state_dict
UnbalancedEnergyModule.step
UnbalancedEnergyModule.to_normalized
UnbalancedEnergyModule.update
UnbalancedEnergyModule.verbose_eq
UnbalancedEnergyModule.absorption_marginal_cost
UnbalancedEnergyModule.action_space
UnbalancedEnergyModule.current_step
UnbalancedEnergyModule.is_sink
UnbalancedEnergyModule.is_source
UnbalancedEnergyModule.log
UnbalancedEnergyModule.logger
UnbalancedEnergyModule.logger_last
UnbalancedEnergyModule.marginal_cost
UnbalancedEnergyModule.max_act
UnbalancedEnergyModule.max_consumption
UnbalancedEnergyModule.max_obs
UnbalancedEnergyModule.max_production
UnbalancedEnergyModule.min_act
UnbalancedEnergyModule.min_obs
UnbalancedEnergyModule.min_production
UnbalancedEnergyModule.module_type
UnbalancedEnergyModule.observation_space
UnbalancedEnergyModule.production_marginal_cost
UnbalancedEnergyModule.state
UnbalancedEnergyModule.yaml_tag
Forecasting
Reinforcement Learning (RL) Environments
pymgrid.envs.DiscreteMicrogridEnv
DiscreteMicrogridEnv.close
DiscreteMicrogridEnv.compute_net_load
DiscreteMicrogridEnv.convert_action
DiscreteMicrogridEnv.deserialize
DiscreteMicrogridEnv.dump
DiscreteMicrogridEnv.flatten_obs
DiscreteMicrogridEnv.from_microgrid
DiscreteMicrogridEnv.from_nonmodular
DiscreteMicrogridEnv.from_normalized
DiscreteMicrogridEnv.from_scenario
DiscreteMicrogridEnv.get_cost_info
DiscreteMicrogridEnv.get_empty_action
DiscreteMicrogridEnv.get_forecast_horizon
DiscreteMicrogridEnv.get_log
DiscreteMicrogridEnv.get_priority_lists
DiscreteMicrogridEnv.load
DiscreteMicrogridEnv.potential_observation_keys
DiscreteMicrogridEnv.remove_action
DiscreteMicrogridEnv.reset
DiscreteMicrogridEnv.run
DiscreteMicrogridEnv.sample_action
DiscreteMicrogridEnv.set_forecaster
DiscreteMicrogridEnv.set_module_attrs
DiscreteMicrogridEnv.state_dict
DiscreteMicrogridEnv.state_series
DiscreteMicrogridEnv.step
DiscreteMicrogridEnv.to_nonmodular
DiscreteMicrogridEnv.to_normalized
DiscreteMicrogridEnv.verbose_eq
DiscreteMicrogridEnv.action_space
DiscreteMicrogridEnv.controllable
DiscreteMicrogridEnv.current_step
DiscreteMicrogridEnv.final_step
DiscreteMicrogridEnv.fixed
DiscreteMicrogridEnv.flat_spaces
DiscreteMicrogridEnv.flex
DiscreteMicrogridEnv.initial_step
DiscreteMicrogridEnv.log
DiscreteMicrogridEnv.module_list
DiscreteMicrogridEnv.modules
DiscreteMicrogridEnv.n_modules
DiscreteMicrogridEnv.np_random
DiscreteMicrogridEnv.observation_space
DiscreteMicrogridEnv.yaml_tag
DiscreteMicrogridEnv.actions_list
pymgrid.envs.ContinuousMicrogridEnv
ContinuousMicrogridEnv.close
ContinuousMicrogridEnv.compute_net_load
ContinuousMicrogridEnv.convert_action
ContinuousMicrogridEnv.deserialize
ContinuousMicrogridEnv.dump
ContinuousMicrogridEnv.flatten_obs
ContinuousMicrogridEnv.from_microgrid
ContinuousMicrogridEnv.from_nonmodular
ContinuousMicrogridEnv.from_normalized
ContinuousMicrogridEnv.from_scenario
ContinuousMicrogridEnv.get_cost_info
ContinuousMicrogridEnv.get_empty_action
ContinuousMicrogridEnv.get_forecast_horizon
ContinuousMicrogridEnv.get_log
ContinuousMicrogridEnv.load
ContinuousMicrogridEnv.potential_observation_keys
ContinuousMicrogridEnv.reset
ContinuousMicrogridEnv.run
ContinuousMicrogridEnv.sample_action
ContinuousMicrogridEnv.set_forecaster
ContinuousMicrogridEnv.set_module_attrs
ContinuousMicrogridEnv.state_dict
ContinuousMicrogridEnv.state_series
ContinuousMicrogridEnv.step
ContinuousMicrogridEnv.to_nonmodular
ContinuousMicrogridEnv.to_normalized
ContinuousMicrogridEnv.verbose_eq
ContinuousMicrogridEnv.action_space
ContinuousMicrogridEnv.check_actions
ContinuousMicrogridEnv.controllable
ContinuousMicrogridEnv.current_step
ContinuousMicrogridEnv.final_step
ContinuousMicrogridEnv.fixed
ContinuousMicrogridEnv.flat_spaces
ContinuousMicrogridEnv.flex
ContinuousMicrogridEnv.initial_step
ContinuousMicrogridEnv.log
ContinuousMicrogridEnv.module_list
ContinuousMicrogridEnv.modules
ContinuousMicrogridEnv.n_modules
ContinuousMicrogridEnv.np_random
ContinuousMicrogridEnv.observation_space
ContinuousMicrogridEnv.yaml_tag
Control Algorithms
pymgrid.algos.RuleBasedControl
RuleBasedControl.get_action
RuleBasedControl.get_priority_lists
RuleBasedControl.reset
RuleBasedControl.run
RuleBasedControl.priority_list
RuleBasedControl.microgrid
pymgrid.algos.ModelPredictiveControl
ModelPredictiveControl.get_action
ModelPredictiveControl.reset
ModelPredictiveControl.run
ModelPredictiveControl.solver_context
General functions and objects
pymgrid.modules.ModuleContainer
ModuleContainer.clear
ModuleContainer.copy
ModuleContainer.fromkeys
ModuleContainer.get
ModuleContainer.get_attrs
ModuleContainer.items
ModuleContainer.iterdict
ModuleContainer.iteritems
ModuleContainer.iterlist
ModuleContainer.keys
ModuleContainer.names
ModuleContainer.pop
ModuleContainer.popitem
ModuleContainer.set_attrs
ModuleContainer.setdefault
ModuleContainer.to_dict
ModuleContainer.to_list
ModuleContainer.to_tuples
ModuleContainer.update
ModuleContainer.values
ModuleContainer.containers
pymgrid.utils.space.ModuleSpace
ModuleSpace.clip
ModuleSpace.contains
ModuleSpace.denormalize
ModuleSpace.from_jsonable
ModuleSpace.inner_clip
ModuleSpace.normalize
ModuleSpace.sample
ModuleSpace.seed
ModuleSpace.to_jsonable
ModuleSpace.is_np_flattenable
ModuleSpace.normalized
ModuleSpace.np_random
ModuleSpace.shape
ModuleSpace.unnormalized
Indices
General Index
API reference
pymgrid.modules.battery.transition_models.BatteryTransitionModel
BatteryTrans...
BatteryTransitionModel.new_kwargs
#
BatteryTransitionModel.
new_kwargs
(
)
[source]
#
On this page
BatteryTransitionModel.new_kwargs()
Show Source