System Class Reference

Class that generates the system from a data folder. More...

Inheritance diagram for System:

Collaboration diagram for System:

Public Member Functions
def	__init__
	Constructor. More...
def	generate
	Generate the system. More...
def	run
def	hasConverged

Static Public Attributes
string	pricesFile = "prices.csv"
	Name of the file with the prices. More...
string	networkFile = 'network.csv'
	Name of the data file for the network. More...

Private Member Functions
def	_prepareOperationFolder
	Prepare the operation folder. More...
def	_readGeneralData
	Read general data of the system. More...

Private Attributes
	_dataFolder
	Folder with the data of the whole market. More...
	_outputSolutionFile
	XML output solution file. More...
	_dso
	DSO. More...
	_tso
	TSO. More...
	_retailers
	List of retailers. More...
	_producers
	List of producers. More...

Detailed Description

Class that generates the system from a data folder.

The system class defines the following global data:

• DSO,TSO, flexibilityPlatform : pointing to the instance of the actors.
• time : After a run, provides the time taken.
• iterations : After a run, provides the number of iterations performed.
• T : Number of periods in the system.
• N : Number of nodes.
• pi^i : Nodal imbalance price in case of DSO network failure.
• pi^E, pi^I+, pi^I- : For each period, the energy price and the downward and upward imbalance tariffs.

Constructor & Destructor Documentation

def __init__	(		self,
			dataFolder,
			maximumIterations = 1000,
			outputSolutionFile = "data.xml",
			convergenceTolerance = None
	)

Constructor.

Parameters

dataFolder	Folder with the data of the whole market.
maximumIterations	Maximum number of iterations.
outputSolutionFile	XML output solution file.
convergenceTolerance	Numerical tolerance for the convergence criteria. If none, set to options.EPS

Member Function Documentation

def _prepareOperationFolder (   self )

private

Prepare the operation folder.

Creates it if needed and copy the models into it.

def _readGeneralData (   self )

private

Read general data of the system.

def generate

(

self

)

Generate the system.

def hasConverged

(

self

)

def run

(

self

)

Member Data Documentation

_dataFolder

private

Folder with the data of the whole market.

_dso

private

DSO.

_outputSolutionFile

private

XML output solution file.

_producers

private

List of producers.

_retailers

private

List of retailers.

_tso

private

TSO.

string networkFile = 'network.csv'

static

Name of the data file for the network.

string pricesFile = "prices.csv"

static

Name of the file with the prices.

---

The documentation for this class was generated from the following file:

• simulator/src/system.py