globalResults Namespace Reference

Functions
def	addResults
	Add the results given by the xml file. More...
def	outputXML
	Create an xml file with the global results. More...
def	getGlobalResults
	Get the global results for the simulated days. More...

Variables
dictionary	attributes
	List of attributes to display in the global results. More...
dictionary	dayData
	List of data to get for each day. More...
tuple	tic = time.time()

Detailed Description

Scripts that create an xml file with the global results

Function Documentation

def globalResults.addResults	(		results,
			dayResults,
			actorCosts,
			xmlFile,
			day
	)

Add the results given by the xml file.

Parameters

results	Dictionnary with the results of the previous days.
dayResults	Dictionnary with the individual results of the previous days.
actorCosts	Costs for each actors.
xmlFile	File like object containing the results.
day	Day index

def globalResults.getGlobalResults	(		hash,
			path = "instances"
	)

Get the global results for the simulated days.

Parameters

hash	Hash of the instance.
path	Path to the instance simulation results.

def globalResults.outputXML	(		path,
			results,
			dayResults,
			actorCosts
	)

Create an xml file with the global results.

Parameters

path	Target path.
results	Results dictionary.
dayResults	Dictionnary with the individual results of the previous days.
actorCosts	Costs for each actors.

Variable Documentation

dictionary attributes

Initial value:

= {"Welfare":{"unit":"€"},
                        "Shedding costs":{"unit":"€"},
                        "DSOs costs":{"unit":"€"},
                        "TSOs surplus":{"unit":"€"},
                        "Producers surplus":{"unit":"€"},
                        "Retailers surplus":{"unit":"€"},
                        "Total energy shed":{"unit":"MWh"},
                        "Max. imbalance":{"unit":"MW"},
                        "Total production":{"unit":"MWh"},
                        "Total consumption":{"unit":"MWh"},
                        "Total imbalance":{"unit":"MWh"},
                        "Total usage of flex.":{"unit":"MWh"},
                        "Total opp. usage of flex.":{"unit":"MWh"}
                        }

List of attributes to display in the global results.

dictionary dayData

Initial value:

= {"Welfare":{"unit":"€"},
                 "Time":{"unit":"s"},
                 "Iterations":{"unit":''},
                 "DSOs costs":{"unit":"€"},
                 "Shedding costs":{"unit":"€"},
                 "TSOs surplus":{"unit":"€"},
                 "Producers surplus":{"unit":"€"},
                 "Retailers surplus":{"unit":"€"},
                 "Total energy shed":{"unit":"MWh"},
                 "Total production":{"unit":"MWh"},
                 "Total consumption":{"unit":"MWh"},
                 "Max. imbalance":{"unit":"MW"},
                 "Total imbalance":{"unit":"MWh"},
                 "Total usage of flex.":{"unit":"MWh"}
                }

List of data to get for each day.

tuple tic = time.time()