import warnings
-[docs]class EnergySystemModel:
+[docs]class EnergySystemModel:
"""
EnergySystemModel class
@@ -210,7 +210,7 @@ Source code for energySystemModel
|br| @author: Lara Welder
"""
-[docs] def __init__(self, locations, commodities, commodityUnitsDict, numberOfTimeSteps=8760, hoursPerTimeStep=1,
+[docs] def __init__(self, locations, commodities, commodityUnitsDict, numberOfTimeSteps=8760, hoursPerTimeStep=1,
costUnit='1e9 Euro', lengthUnit='km', verboseLogLevel=0):
"""
Constructor for creating an EnergySystemModel class instance
@@ -377,7 +377,7 @@ Source code for energySystemModel
# The optimization solver logging can be separately enabled in the optimizationSpecs of the optimize function.
self.verbose = verboseLogLevel
-[docs] def add(self, component):
+[docs] def add(self, component):
"""
Function for adding a component and, if required, its respective modeling class to the EnergySystemModel
instance
@@ -392,7 +392,7 @@ Source code for energySystemModel
raise TypeError('The added component has to inherit from the FINE class ComponentModel.')
component.addToEnergySystemModel(self)
-[docs] def getComponent(self, componentName):
+[docs] def getComponent(self, componentName):
"""
Function which returns a component of the energy system
@@ -408,7 +408,7 @@ Source code for energySystemModel
modelingClass = self.componentNames[componentName]
return self.componentModelingDict[modelingClass].componentsDict[componentName]
-[docs] def getComponentAttribute(self, componentName, attributeName):
+[docs] def getComponentAttribute(self, componentName, attributeName):
"""
Function which returns an attribute of a component considered in the energy system
@@ -423,7 +423,7 @@ Source code for energySystemModel
"""
return getattr(self.getComponent(componentName), attributeName)
-[docs] def getOptimizationSummary(self, modelingClass, outputLevel=0):
+[docs] def getOptimizationSummary(self, modelingClass, outputLevel=0):
"""
Function which returns the optimization summary (design variables, aggregated operation variables,
objective contributions) of a modeling class
@@ -451,7 +451,7 @@ Source code for energySystemModel
df = self.componentModelingDict[modelingClass].optSummary.dropna(how='all')
return df.loc[((df != 0) & (~df.isnull())).any(axis=1)]
-[docs] def cluster(self, numberOfTypicalPeriods=7, numberOfTimeStepsPerPeriod=24, clusterMethod='hierarchical',
+[docs] def cluster(self, numberOfTypicalPeriods=7, numberOfTimeStepsPerPeriod=24, clusterMethod='hierarchical',
sortValues=True, storeTSAinstance=False, **kwargs):
"""
Clusters the time series data of all components considered in the EnergySystemModel instance and then
@@ -550,7 +550,7 @@ Source code for energySystemModel
self.isTimeSeriesDataClustered = True
utils.output("\t\t(%.4f" % (time.time() - timeStart) + " sec)\n", self.verbose, 0)
-[docs] def declareTimeSets(self, pyM, timeSeriesAggregation):
+[docs] def declareTimeSets(self, pyM, timeSeriesAggregation):
""" Set and initialize basic time parameters and sets """
# Store the information if aggregated time series data is considered for modeling the energy system in the pyomo
@@ -626,7 +626,7 @@ Source code for energySystemModel
pyM.ConstraintSharedPotentials = \
pyomo.Constraint(pyM.sharedPotentialDict.keys(), rule=sharedPotentialConstraint)
-[docs] def declareCommodityBalanceConstraints(self, pyM):
+[docs] def declareCommodityBalanceConstraints(self, pyM):
"""
Declare commodity balance constraints (one balance constraint for each commodity, location and time step)
"""
@@ -649,7 +649,7 @@ Source code for energySystemModel
pyM.commodityBalanceConstraint = pyomo.Constraint(pyM.locationCommoditySet, pyM.timeSet,
rule=commodityBalanceConstraint)
-[docs] def declareObjective(self, pyM):
+[docs] def declareObjective(self, pyM):
"""
Declare objective function by obtaining the contributions to the objective function from all modeling classes
Currently, the only objective function which can be selected is the sum of the total annual cost of all
@@ -662,7 +662,7 @@ Source code for energySystemModel
return TAC
pyM.Obj = pyomo.Objective(rule=objective)
-[docs] def declareOptimizationProblem(self, timeSeriesAggregation=False):
+[docs] def declareOptimizationProblem(self, timeSeriesAggregation=False):
"""
Declares the optimization problem belonging to the specified energy system, for which a pyomo discrete model
instance is build and filled with
@@ -741,7 +741,7 @@ Source code for energySystemModel
# Store the buildtime of the optimize function call in the EnergySystemModel instance
self.solverSpecs['buildtime'] = time.time() - timeStart
-[docs] def optimize(self, declaresOptimizationProblem=True, timeSeriesAggregation=False, logFileName='job', threads=3,
+[docs] def optimize(self, declaresOptimizationProblem=True, timeSeriesAggregation=False, logFileName='job', threads=3,
solver='gurobi', timeLimit=None, optimizationSpecs='OptimalityTol=1e-6', warmstart=False):
"""
Optimizes the specified energy system, for which a pyomo discrete model instance is build or called upon.
diff --git a/docs/build/html/energySystemModelDoc.html b/docs/build/html/energySystemModelDoc.html
index 385c65d3..f45c686e 100644
--- a/docs/build/html/energySystemModelDoc.html
+++ b/docs/build/html/energySystemModelDoc.html
@@ -85,12 +85,17 @@
Contents:
+- Installation
+- Examples and Tutorials
- Python package description
+- License
+- About Us
+- Acknowledgement
@@ -297,7 +302,7 @@ EnergySystemModel class
Returns: the component which has the name componentName
Return type: Component
+Return type: Component
Python package description
License
About Us
+Acknowledgement
diff --git a/docs/build/html/licenseDoc.html b/docs/build/html/licenseDoc.html
index f59f3239..7bad292d 100644
--- a/docs/build/html/licenseDoc.html
+++ b/docs/build/html/licenseDoc.html
@@ -90,6 +90,7 @@
Python package description
License
About Us
+Acknowledgement
diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv
index be44501f..6654c869 100644
Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ
diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html
index 90628625..15040b58 100644
--- a/docs/build/html/py-modindex.html
+++ b/docs/build/html/py-modindex.html
@@ -161,6 +161,7 @@ Python Module Index
c |
+ e |
l |
s |
t
@@ -181,6 +182,14 @@ Python Module Index
conversion
+ e
+
+ energySystemModel
+
+
l
diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
index 8ace5c7f..0cb87e25 100644
--- a/docs/build/html/searchindex.js
+++ b/docs/build/html/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["aboutUsDoc","acknowledgementDoc","componentClassDoc","componentsDoc","conversionClassDoc","energySystemModelDoc","examplesDoc","index","installationDoc","licenseDoc","lopfClassDoc","outputManagerDoc","packageDoc","sourceSinkClassDoc","storageClassDoc","transmissionClassDoc"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["aboutUsDoc.rst","acknowledgementDoc.rst","componentClassDoc.rst","componentsDoc.rst","conversionClassDoc.rst","energySystemModelDoc.rst","examplesDoc.rst","index.rst","installationDoc.rst","licenseDoc.rst","lopfClassDoc.rst","outputManagerDoc.rst","packageDoc.rst","sourceSinkClassDoc.rst","storageClassDoc.rst","transmissionClassDoc.rst"],objects:{"":{component:[2,0,0,"-"],conversion:[4,0,0,"-"],lopf:[10,0,0,"-"],sourceSink:[13,0,0,"-"],standardIO:[11,0,0,"-"],storage:[14,0,0,"-"],transmission:[15,0,0,"-"]},"component.Component":{__init__:[2,2,1,""],addToEnergySystemModel:[2,2,1,""],getDataForTimeSeriesAggregation:[2,2,1,""],getTSAOutput:[2,2,1,""],prepareTSAInput:[2,2,1,""],setAggregatedTimeSeriesData:[2,2,1,""],setTimeSeriesData:[2,2,1,""]},"component.ComponentModel":{bigM:[2,2,1,""],capToNbInt:[2,2,1,""],capToNbReal:[2,2,1,""],capacityFix:[2,2,1,""],capacityMinDec:[2,2,1,""],declareBinaryDesignDecisionVars:[2,2,1,""],declareCapacityVars:[2,2,1,""],declareComponentConstraints:[2,2,1,""],declareContinuousDesignVarSet:[2,2,1,""],declareDesignDecisionVarSet:[2,2,1,""],declareDesignVarSet:[2,2,1,""],declareDiscreteDesignVarSet:[2,2,1,""],declareIntNumbersVars:[2,2,1,""],declareOpVarSet:[2,2,1,""],declareOperationVars:[2,2,1,""],declareRealNumbersVars:[2,2,1,""],declareSets:[2,2,1,""],declareVariables:[2,2,1,""],designBinFix:[2,2,1,""],getCommodityBalanceContribution:[2,2,1,""],getObjectiveFunctionContribution:[2,2,1,""],getOptimalValues:[2,2,1,""],getSharedPotentialContribution:[2,2,1,""],operationMode1:[2,2,1,""],operationMode2:[2,2,1,""],operationMode3:[2,2,1,""],operationMode4:[2,2,1,""],operationMode5:[2,2,1,""]},"conversion.Conversion":{__init__:[4,2,1,""],addToEnergySystemModel:[4,2,1,""],getDataForTimeSeriesAggregation:[4,2,1,""],setAggregatedTimeSeriesData:[4,2,1,""],setTimeSeriesData:[4,2,1,""]},"conversion.ConversionModel":{declareComponentConstraints:[4,2,1,""],declareSets:[4,2,1,""],declareVariables:[4,2,1,""],getCommodityBalanceContribution:[4,2,1,""],getObjectiveFunctionContribution:[4,2,1,""],getOptimalValues:[4,2,1,""],getSharedPotentialContribution:[4,2,1,""],linkedCapacity:[4,2,1,""]},"lopf.LOPFModel":{basePhaseAngle:[10,2,1,""],declareComponentConstraints:[10,2,1,""],declareSets:[10,2,1,""],declareVariables:[10,2,1,""],getCommodityBalanceContribution:[10,2,1,""],getObjectiveFunctionContribution:[10,2,1,""],getOptimalValues:[10,2,1,""],getSharedPotentialContribution:[10,2,1,""],initPhaseAngleVarSet:[10,2,1,""],powerFlowDC:[10,2,1,""]},"lopf.LinearOptimalPowerFlow":{__init__:[10,2,1,""],addToEnergySystemModel:[10,2,1,""]},"sourceSink.Sink":{__init__:[13,2,1,""]},"sourceSink.Source":{__init__:[13,2,1,""],addToEnergySystemModel:[13,2,1,""],getDataForTimeSeriesAggregation:[13,2,1,""],setAggregatedTimeSeriesData:[13,2,1,""],setTimeSeriesData:[13,2,1,""]},"sourceSink.SourceSinkModel":{declareComponentConstraints:[13,2,1,""],declareSets:[13,2,1,""],declareVariables:[13,2,1,""],getCommodityBalanceContribution:[13,2,1,""],getObjectiveFunctionContribution:[13,2,1,""],getOptimalValues:[13,2,1,""],getSharedPotentialContribution:[13,2,1,""],yearlyLimitationConstraint:[13,2,1,""]},"storage.Storage":{__init__:[14,2,1,""],addToEnergySystemModel:[14,2,1,""],getDataForTimeSeriesAggregation:[14,2,1,""],setAggregatedTimeSeriesData:[14,2,1,""],setTimeSeriesData:[14,2,1,""]},"storage.StorageModel":{connectInterPeriodSOC:[14,2,1,""],connectSOCs:[14,2,1,""],cyclicLifetime:[14,2,1,""],cyclicState:[14,2,1,""],declareComponentConstraints:[14,2,1,""],declareSets:[14,2,1,""],declareVariables:[14,2,1,""],equalInterSOC:[14,2,1,""],getCommodityBalanceContribution:[14,2,1,""],getObjectiveFunctionContribution:[14,2,1,""],getOptimalValues:[14,2,1,""],getSharedPotentialContribution:[14,2,1,""],intraSOCstart:[14,2,1,""],limitSOCwithSimpleTsa:[14,2,1,""],minSOC:[14,2,1,""],minSOCwithTSAprecise:[14,2,1,""],operationModeSOC:[14,2,1,""],operationModeSOCwithTSA:[14,2,1,""]},"transmission.Transmission":{__init__:[15,2,1,""],addToEnergySystemModel:[15,2,1,""],getDataForTimeSeriesAggregation:[15,2,1,""],setAggregatedTimeSeriesData:[15,2,1,""],setTimeSeriesData:[15,2,1,""]},"transmission.TransmissionModel":{declareComponentConstraints:[15,2,1,""],declareSets:[15,2,1,""],declareVariables:[15,2,1,""],getCommodityBalanceContribution:[15,2,1,""],getObjectiveFunctionContribution:[15,2,1,""],getOptimalValues:[15,2,1,""],getSharedPotentialContribution:[15,2,1,""],operationMode1_2dim:[15,2,1,""],symmetricalCapacity:[15,2,1,""]},component:{Component:[2,1,1,""],ComponentModel:[2,1,1,""]},conversion:{Conversion:[4,1,1,""],ConversionModel:[4,1,1,""]},lopf:{LOPFModel:[10,1,1,""],LinearOptimalPowerFlow:[10,1,1,""]},sourceSink:{Sink:[13,1,1,""],Source:[13,1,1,""],SourceSinkModel:[13,1,1,""]},standardIO:{energySystemModelRunFromExcel:[11,3,1,""],getDualValues:[11,3,1,""],getShadowPrices:[11,3,1,""],plotLocationalColorMap:[11,3,1,""],plotLocations:[11,3,1,""],plotOperation:[11,3,1,""],plotOperationColorMap:[11,3,1,""],plotTransmission:[11,3,1,""],readEnergySystemModelFromExcel:[11,3,1,""],writeOptimizationOutputToExcel:[11,3,1,""]},storage:{Storage:[14,1,1,""],StorageModel:[14,1,1,""]},transmission:{Transmission:[15,1,1,""],TransmissionModel:[15,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"1dim":2,"1e3":11,"1e6":[2,4,13,14,15],"1e9":5,"20energi":[],"20system":[],"20workflow":[],"2dim":2,"abstract":[2,4,13,14,15],"boolean":[2,4,5,11,13,14,15],"case":[2,4,13,14,15],"class":[3,11,12],"default":[2,4,5,11,13,14,15],"export":13,"float":[2,4,11,13,14,15],"function":[2,4,5,10,11,12,13,14,15],"import":13,"int":11,"j\u00fclich":0,"lin\u00dfen":9,"new":0,"public":7,"return":[2,4,5,10,11,13,14,15],"short":14,"true":[2,4,5,10,11,13,14,15],"while":7,For:[3,5],Has:2,The:[0,2,3,4,5,7,10,12,13,14,15],Then:[],There:3,These:[3,5],Used:2,With:[5,7],__init__:[2,4,5,10,13,14,15],_node:[],_process:[],about:7,absolut:[4,5,13,14,15],access:5,accord:0,acknowledg:7,add:[2,4,5,10,13,14,15],added:[2,3,4,5,10,11,13,14,15],adding:[2,5],addit:[2,5],addition:10,addtoenergysystemmodel:[2,4,10,13,14,15],advanc:5,after:[2,4,13,14,15],again:5,aggreat:[2,4,13,14,15],aggreg:[2,4,5,7,13,14,15],aka:2,algorithm:5,all:[2,3,4,5,10,11,13,14,15],allow:13,along:[],alpha:11,alreadi:[2,4,10,13,14,15],also:[2,13,15],altern:8,analys:0,analysi:0,angl:10,annual:[2,4,5,7,13,14,15],annuiti:2,anoth:[2,4,10,13,14,15],appli:[2,4,7,13,14,15],applic:2,area:11,areafactor:11,argument:[2,4,5,10,13,14,15],aris:[2,5],articl:7,artifici:2,assess:0,assign:[4,5,14],associ:1,assum:2,atmospher:13,attribut:5,attributenam:5,august:5,author:[4,5],avail:[2,5,11],averag:5,avoid:2,axi:11,backward:15,balanc:[0,2,4,5,10,13,14,15],base:[2,5,7],basephaseangl:10,basic:[2,3,5,11,15],befor:[5,14,15],begin:[5,14],behavior:[3,10],being:15,belong:[0,5],below:[2,4,5,10,11,13,14,15],benefit:14,besid:7,best:5,between:[0,2,10,14,15],bigm:[2,4,10,13,14,15],billion:5,binari:[2,11],bioga:2,black:11,both:15,bound:2,boundari:13,broken:5,build:[5,11],built:[2,5],burn:13,cabl:2,call:[3,5,11],can:[2,3,4,5,7,13,14,15],cannot:14,capabilit:[],capabl:6,capac:[2,4,5,10,11,13,14,15],capacityfix:[2,4,10,13,14,15],capacitymax:[2,4,10,13,14,15],capacitymin:[2,4,10,13,14,15],capacitymindec:2,capacityperplantunit:[2,4,10,13,14,15],capacityvari:[2,4,10,11,13,14,15],capacityvariabledomain:[2,4,10,13,14,15],capacityvariablesoptimum:11,captonbint:2,captonbr:2,captur:15,categor:[],cavern:14,cell:4,certain:[13,15],chain:0,chang:14,charg:14,chargeeffici:14,chargeoperationvariablesoptimum:14,chargeopr:14,chargeopratefix:14,chargeopratemax:14,charger:14,chargetsaweight:14,check:[2,4],checkout:11,chemic:13,chemicalcomponentlimitid:13,chosen:[2,5],cite:7,climat:0,clone:8,cluster:[2,5],clustermethod:5,cmap:11,co2:[2,13],coal:13,code:12,coeffici:5,coincid:13,collect:2,color:11,column:[4,10,11,13,14,15],com:[5,7,8],combin:15,come:15,command:8,commod:[2,4,5,7,10,13,14,15],commoditiylimitid:13,commoditybalanceconstraint:11,commodityconversionfactor:4,commoditycost:13,commoditylimitid:13,commodityrevenu:13,commodityunit:[2,13,14,15],commodityunitsdict:5,compar:[0,14],complex:7,compnam:11,compon:[4,5,10,11,12,13,14,15],componentclassdoc:[],componentmodel:[2,3,4,10,13,14,15],componentmodelingdict:5,componentnam:5,comput:[2,5,7,8],concret:5,conduct:0,connect:[2,14,15],connectinterperiodsoc:14,connectsoc:14,consid:[2,4,5,7,10,11,13,14,15],consider:2,consist:[2,4],consol:5,constitut:5,constraint:[2,4,5,7,10,11,13,14,15],constrnam:[2,15],constrsetnam:[2,15],constructor:[2,4,5,10,13,14,15],consum:[4,13],contain:[5,11],content:[7,12],continu:[2,4,10,13,14,15],contribut:[1,2,4,5,10,13,14,15],control:14,convent:2,convers:[2,3,5,10,12,15],conversionmodel:[3,4],convert:[2,4],coordin:11,copi:8,copyright:9,core:5,corecomponentsdoc:[],correspond:[2,7],cost:[0,2,4,5,7,13,14,15],costunit:5,could:13,countri:13,cours:5,creat:[2,4,5,10,13,14,15],crs:11,current:[0,5],curv:5,cycl:14,cyclic:14,cycliclifetim:14,cyclicst:14,dai:[5,11],daili:14,data:[0,2,3,4,5,11,13,14,15],datafram:[2,4,10,13,14,15],decis:2,declar:[2,4,5,10,13,14,15],declarebinarydesigndecisionvar:2,declarecapacityvar:2,declarecommoditybalanceconstraint:5,declarecomponentconstraint:[2,4,10,13,14,15],declarecontinuousdesignvarset:2,declaredesigndecisionvarset:2,declaredesignvarset:2,declarediscretedesignvarset:2,declareintnumbersvar:2,declareobject:5,declareoperationvar:2,declareoptimizationproblem:5,declareopvarset:2,declarerealnumbersvar:2,declareset:[2,4,10,13,14,15],declaresoptimizationproblem:5,declaretimeset:5,declarevari:[2,4,10,13,14,15],defin:[2,3,4,5,14,15],depart:0,depend:[4,5,10,13,14,15],depreci:2,deriv:5,describ:[4,10,12,13,14,15],descript:[2,4,5,7,10,11,13,14,15],design:[0,2,4,5,10,13,14,15],designbinfix:2,detail:5,determin:[0,2,14],detlef:9,develop:0,diagram:[2,4,10,13,14,15],dict:2,dictionari:[2,4,5,10,13,14,15],differenti:13,dimens:2,direct:15,directli:[4,8,13,14,15],directori:5,discharg:14,dischargeeffici:14,dischargeoperationvariablesoptimum:14,dischargeopr:14,dischargeopratefix:14,dischargeopratemax:14,discharger:14,dischargetsaweight:14,discret:[2,5],displai:5,distanc:[10,15],divid:2,doc:[2,4,10,13,14,15],document:5,doe:2,dollar:[2,4,13,14,15],domain:2,done:[2,5],doprecisetsamodel:14,dosum:11,dot:11,down:5,download:8,dpi:11,drop:[5,11,14],dual:11,dualvalu:11,due:2,durat:5,dure:[5,13,14,15],each:[2,4,5,10,11,13,14,15],econom:2,economiclifetim:[2,4,10,13,14,15],edg:11,edgecolor:11,edit:[4,5],effici:[4,14],either:[2,4,13,14,15],electr:[2,4,13],electrochem:0,electrolyz:[2,4],elig:2,els:2,emiss:0,emit:[2,13],enabl:5,end:[11,14],energi:[0,1,2,3,4,5,10,11,13,14,15],energy_system_2050:[],energysystemmodel:[2,3,4,10,11,12,13,14,15],energysystemmodelrunfromexcel:11,energyunit:14,enforc:[2,4,10,15],engin:0,ensur:2,enter:[13,14],entri:[4,13,14,15],enviroment:7,environ:[2,5,13],epsg:11,equal:[2,4,10,13,14,15],equalintersoc:14,equat:10,equival:14,error:14,esm:[2,4,10,11,13,14,15],esmdata:11,especi:14,etc:14,euro:[2,4,5,13,14,15],evalu:0,exact:5,exampl:[2,3,4,5,7,13,14],exce:14,excel:11,execut:5,exist:2,extend:3,extrem:5,face:11,facecolor:11,facilit:5,factor:[2,4,14,15],factornam:2,fals:[2,4,5,10,11,13,14,15],featur:7,feder:0,feed:13,field:1,fig:11,figsiz:11,figur:11,file:[5,11],filenam:11,fill:5,fine:[2,3,4,5,6,8,10,13,14,15],first:[7,11,15],fit:2,five:3,fix:[2,4,13,14,15],flow:[10,13,15],focus:0,folder:8,follow:7,fontsiz:11,form:[3,4,13,14,15],format:2,formul:7,forschung:[],forschungszentrum:0,forward:15,found:7,fourfold:5,framework:[0,6],free:2,from:[2,3,5,11,13,14,15],fuel:4,full:[2,4,5,7,13,14,15],further:[2,3,5],futur:0,fzj:[5,7,8,9],gas:[0,13],gener:[4,5,10,11,12,13,14,15],german:0,get:[2,4,5,10,11,13,14,15],getcommoditybalancecontribut:[2,4,10,13,14,15],getcompattr:5,getcompon:5,getcomponentattribut:5,getcwd:5,getdatafortimeseriesaggreg:[2,4,13,14,15],getdualvalu:11,getobjectivefunctioncontribut:[2,4,10,13,14,15],getoptimalvalu:[2,4,10,13,14,15],getoptimizationsummari:5,getshadowpric:11,getsharedpotentialcontribut:[2,4,10,13,14,15],gettsaoutput:2,git:8,github:[5,6,7,8],give:[7,12],given:[2,4,5,11,13,14,15],goe:13,going:15,govern:0,greenhous:0,gurobi:5,gw_el:5,gw_electr:[2,4,13],gw_h2:5,gw_hydrogen_lowerheatingvalu:4,gwh_h2_lhv:14,hand:[2,5],happen:14,has:[2,4,5,11,13,14,15],hascapacityvari:[2,4,10,13,14,15],hascapaityvari:13,hasisbuiltbinaryvari:[2,4,10,13,14,15],hastsa:[2,4,13,14,15],have:[2,3,4,10,13,14,15],heat:11,helmholtz:1,here:7,hierarch:5,hold:[2,11],home:[],home_nod:[],hour:[2,5,11,14,15],hourspertimestep:5,household:13,how:[2,5],howev:2,html:[],http:[5,7,8],hydrogen:[4,14],iek3:[5,7,8],iek:[0,9],ifbuiltbinaryvari:2,implement:[2,4,13,14,15],inch:11,includ:[0,11],independ:[2,4,10,13,14,15],index:[7,11],indexcolumn:11,indic:[2,4,5,10,11,13,14,15],inflow:14,influenc:5,inform:5,infrastructur:0,inherit:[2,3,4,5,10,13,14,15],inhert:2,initcontinuousdesignvarset:[],initdesigndecisionvarset:[],initdesignvarset:[],initdiscretedesignvarset:[],initi:[1,5,13],initopvarset:[],initphaseanglevarset:10,inject:14,input:[2,4,5,10,12,13,14,15],instal:[2,4,5,7,11,13,14,15],instanc:[2,4,5,10,11,13,14,15],institut:0,integ:[2,5,11],integr:0,interconnect:7,interdisciplinari:0,interest:2,interestr:[2,4,10,13,14,15],interperiodtimestep:5,intrasocstart:14,invest:[2,5],investifbuilt:[2,4,10,13,14,15],investig:5,investpercapac:[2,4,10,13,14,15],ipynb:[],isbuilt:2,isbuiltfix:[2,4,10,13,14,15],isbuiltvari:[2,4,10,13,14,15],isperiodicalstorag:14,isstateofcharg:2,istimeseriesdataclust:5,its:[2,5,7,14],itself:[2,5,12,14],job:5,jochen:9,join:5,joint:1,juelich:[],juli:[4,5],jupyt:[],k_mean:5,k_medoid:5,kei:[2,4,10,13,14,15],kept:11,keyword:5,kilomet:[5,11],kindli:7,kwarg:[5,11],label:11,lara:[4,5,9],larg:2,larger:[5,14],last:[4,5,11],lead:15,leav:13,legend:11,length:[5,11],lengthunit:[2,5,15],less:2,level:[5,11],licens:7,lifetim:[2,14],limit:[2,4,5,13,14,15],limitsocwithsimpletsa:14,line:[11,15],linear:[10,15],linearoptimalpowerflow:[3,12],linewidth:11,linkedcapac:4,linkedconversioncapacityid:4,list:2,literatur:7,loc0:11,loc1:11,loc:[2,4,10,11,13,14,15],local:8,locat:[2,4,5,7,8,10,11,13,14,15],location1_location2:15,location_1:[10,15],location_2:[10,15],locationalelig:[2,4,10,13,14,15],locationsshapefilenam:11,loctran:11,log:5,logfilenam:5,logtoconsol:5,lopf:10,lopfmodel:[3,10],loss:[10,15],machin:5,manag:12,map:[2,11],mark:5,market:0,martin:9,mass:0,match:[2,4,13,14,15],mathemat:2,matplotlib:11,max:14,maxdepth:[],maximum:[2,4,5,11,13,14,15],meter:11,methan:[2,13],method:[2,4,5,13,14,15],might:5,minim:[5,7],minimum:[2,5,11,14],minsoc:14,minsocwithtsaprecis:14,minu:14,mio:5,mit:9,mode:2,model:[2,3,4,5,7,10,11,13,14,15],modelingclass:[2,5],modul:[5,7,12],more:5,much:2,multi:[],multipl:[2,5,7,13],multipli:[2,4,13,14,15],must:5,name:[2,4,5,10,11,13,14,15],nan:5,nation:[5,13],natur:13,nbperiod:11,nbtimestepsperperiod:11,necessari:2,neg:[4,13],never:2,node:10,none:[2,4,5,10,11,13,14,15],note:[5,13],notebook:[],notimplementederror:[2,4,13,14,15],notypicalperiod:5,novemb:5,nper:11,number:[2,5,11,14],numberoftimestep:5,numberoftimestepsperperiod:5,numberoftypicalperiod:5,numer:5,object:[2,4,5,10,13,14,15],obtain:[2,4,5,11,13,14,15],onc:5,one:[2,4,5,10,13,14,15],onli:[2,5,11],opensourc:[],oper:[2,4,5,10,11,13,14,15],operationmode1:2,operationmode1_2dim:15,operationmode2:2,operationmode3:2,operationmode4:2,operationmode5:2,operationmodesoc:14,operationmodesocwithtsa:14,operationratefix:[4,10,13,15],operationratemax:[4,10,13,15],operationvariablesoptimum:[2,4,10,11,13,15],opexifbuilt:[2,4,10,13,14,15],opexpercapac:[2,4,10,13,14,15],opexperchargeoper:14,opexperdischargeoper:14,opexperoper:[4,10,13,14,15],optim:[2,4,5,7,10,11,13,14,15],optimalitytol:5,optimizationspec:5,option:[2,5,11],optsumoutputlevel:11,optvaloutputlevel:11,opvarnam:[2,15],order:5,org:[],origin:[2,5],other:[2,4,5,15],otherwis:[2,4,5,13,14,15],our:0,out:13,outflow:14,output:[2,5,12],outputfilenam:11,outputlevel:5,over:[2,13,15],overal:13,overreach:5,packag:[2,5,7],page:[6,7],panda:[2,4,10,11,13,14,15],param:11,paramet:[2,4,5,10,11,13,14,15],path:[5,11],pdf:5,per:[2,5,11,13,15],perarea:11,percentag:14,perform:0,period:[5,7,11,14],periodsoccurr:5,periodsord:5,perspect:2,phase:10,phaseanglevariablesoptimum:10,physic:4,physicalunit:[2,4,14],pii:7,pip:8,plant:[2,4,13],pleas:[5,7],plot:11,plotloc:11,plotlocationalcolormap:11,plotlocnam:11,plotoper:11,plotoperationcolormap:11,plottransmiss:11,plu:14,png:11,point:15,posit:[2,4,5,11,13,14,15],possibl:[2,15],post:5,potenti:[2,4,10,13,14,15],power:[2,10,13],powerflowdc:10,powerunit:14,precis:14,preparetsainput:2,previous:5,price:11,prioriti:0,problem:[2,5,11],process:[0,2,5,13],produc:[4,13],profil:5,program:[],prompt:8,proport:[4,13,14,15],protect:5,provid:[2,5,7],publish:7,purchas:13,pure:2,put:4,pym:[2,4,5,10,11,13,14,15],pyomo:[2,5,10,11],python:[5,7,8],quantit:5,rais:[2,4,13,14,15],rang:5,rate:[2,4,13,14,15],ratefix:2,ratemax:2,ratenam:2,rateweight:2,ratio:14,reach:2,reactanc:10,read:11,readenergysystemmodelfromexcel:11,real:2,reason:5,receiv:[],reduc:7,reduct:0,refer:[4,5,10,11,14,15],reformat:2,region:7,rel:[4,13,14,15],relat:[0,2,4,5,13,14,15],relev:[2,14],remain:2,repositori:8,repres:[2,4,5,10,13,14,15],represent:[5,7],requir:[2,4,5,10,11,13,14,15],research:[0,1],reset:5,resolut:[5,7,11],respect:[2,3,4,5,10,13,14,15],restrain:14,restrict:5,result:[0,5],revenu:13,robiniu:9,row:[4,5,10,13,14,15],run:[5,11,14],runtim:5,s036054421830879x:7,salt:14,same:[2,4,10,13,14,15],save:11,scalar:11,scale:5,scenarioinput:11,scenariooutput:11,scienc:7,sciencedirect:7,script:5,search:[0,7],second:[2,5,11,15],secur:0,see:[5,11,13],select:[5,14],self:14,selfdischarg:14,separ:[5,15],sequenc:5,seri:[2,4,5,7,11,13,14,15],serv:5,set:[2,4,5,10,11,13,14,15],setaggregatedtimeseriesdata:[2,4,13,14,15],settimeseriesdata:[2,4,13,14,15],setup:8,shadow:11,shape:11,share:[2,4,10,13,14,15],sharedpotentialid:[2,4,10,13,14,15],should:[2,4,5,10,11,13,14,15],show:[6,10],sign:13,simpl:15,simpli:4,simplifi:14,simul:[0,5],sinc:15,sink:[3,5,12],size:11,small:[2,14],smaller:14,solut:[5,15],solv:5,solver:5,solverspec:5,sort:5,sortvalu:5,sourc:[2,3,4,5,10,11,12,14,15],sourcesink:13,sourcesinkmodel:[3,13],space:2,spatial:5,specif:[2,4,10,13,14,15],specifi:[2,4,5,10,11,13,14,15],stabil:5,stage:7,stai:14,standard:12,standardio:11,start:[5,11],state:[5,14],stateofchargemax:14,stateofchargemin:14,stateofchargeoperationvariablesoptimum:14,step:[2,4,5,7,10,11,13,14,15],stolten:9,storag:[2,3,5,7,12],storagemodel:[3,14],store:[3,5,11,14],storetsainst:5,strategi:0,strictli:[2,5],string:[2,4,5,11,13,14,15],structur:[5,12],studi:0,subclass:[2,3,4,13,14,15],subclasscomponentsdoc:[],submiss:5,suggest:5,suitabl:5,sum:[4,5,13,14,15],summar:11,summari:[5,11],suppli:0,support:[1,5,14],sustain:0,symmetricalcapac:15,system:[0,1,2,3,4,5,10,11,13,14,15],t_co2:5,tac:5,taken:13,target:[0,7],tariff:13,technic:7,technolog:[0,14],tempor:[5,7],term:14,than:[5,14],thei:[2,5,13],themselv:13,theoret:2,thi:[1,2,4,5,13,14,15],thread:5,threshold:14,thu:[2,5,14],time:[2,4,5,7,10,11,13,14,15],timelimit:5,timeseriesaggreg:5,timestepsperperiod:5,timeunit:5,tmax:11,tmin:11,toctre:[],togeth:5,tonnes_chem:13,tonnes_co2:13,too:15,total:[5,7,14],totaltimestep:5,tpye:[2,4,13,14,15],tran:15,trans_in_ij:15,trans_out_ij:15,transfer:[13,14],transform:14,transmiss:[2,3,5,10,11,12],transmissionmodel:[3,10,15],transmissionshapefilenam:11,transmit:15,transpar:11,trigger:5,tsainstanc:5,tsam:[5,7],tsamweight:13,tsaweight:[4,10,13,15],tupl:11,tupli:11,turbin:[2,13],tutori:7,two:2,txt:5,type:[5,8,11],typic:[5,7,14],typicalperiod:5,unclust:2,under:[1,14],underscor:[5,15],uniqu:2,unit:[2,4,5,13,14,15],unlimit:2,unnecessari:2,until:5,upon:5,upper:2,use:[5,7],used:[0,2,5,13],useful:5,user:5,using:[2,5,7,11,14],util:[4,13,14,15],valu:[2,4,5,10,11,13,14,15],variabl:[2,4,5,10,11,12,13,14,15],variablenam:11,variou:0,verbos:5,verboseloglevel:5,version:14,via:8,virtual:14,vmax:11,vmin:11,vsa:[5,7,8],want:7,warm:5,warmstart:5,warn:5,weight:[2,4,13,14,15],weightdict:2,welder:[4,5,9],well:[0,2,4,10,13,14,15],when:[2,4,5,11,13,14,15],where:[5,8,14,15],whether:14,which:[2,4,5,7,10,11,13,14,15],wind:[2,13],withdrawn:14,within:5,without:11,work:[1,7],write:11,writeoptimizationoutputtoexcel:11,www:7,xlabel:11,xlsx:11,year:[5,13],yearli:13,yearlylimit:13,yearlylimitationconstraint:13,ylabel:11,you:7,your:8,zero:[10,11,14,15],zip:[],zlabel:11},titles:["About Us","Acknowledgement","Component class","Components","Conversion class","EnergySystemModel class","Examples and Tutorials","Welcome to FINE\u2019s documentation!","Installation","License","LinearOptimalPowerFlow classes","Input Output Management","Python package description","Source and Sink class","Storage class","Transmission class"],titleterms:{"class":[2,4,5,10,13,14,15],about:0,acknowledg:1,assess:7,compon:[2,3],convers:4,core:[],descript:12,document:7,energi:7,energysystemmodel:5,exampl:6,extend:[],fine:7,framework:7,input:11,instal:8,integr:7,licens:9,linearoptimalpowerflow:10,manag:11,output:11,packag:12,python:12,sink:13,sourc:13,standard:11,storag:14,system:7,transmiss:15,tutori:6,welcom:7}})
\ No newline at end of file
+Search.setIndex({docnames:["aboutUsDoc","acknowledgementDoc","componentClassDoc","componentsDoc","conversionClassDoc","energySystemModelDoc","examplesDoc","index","installationDoc","licenseDoc","lopfClassDoc","outputManagerDoc","packageDoc","sourceSinkClassDoc","storageClassDoc","transmissionClassDoc"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":1,"sphinx.ext.viewcode":1,sphinx:55},filenames:["aboutUsDoc.rst","acknowledgementDoc.rst","componentClassDoc.rst","componentsDoc.rst","conversionClassDoc.rst","energySystemModelDoc.rst","examplesDoc.rst","index.rst","installationDoc.rst","licenseDoc.rst","lopfClassDoc.rst","outputManagerDoc.rst","packageDoc.rst","sourceSinkClassDoc.rst","storageClassDoc.rst","transmissionClassDoc.rst"],objects:{"":{component:[2,0,0,"-"],conversion:[4,0,0,"-"],energySystemModel:[5,0,0,"-"],lopf:[10,0,0,"-"],sourceSink:[13,0,0,"-"],standardIO:[11,0,0,"-"],storage:[14,0,0,"-"],transmission:[15,0,0,"-"]},"component.Component":{__init__:[2,2,1,""],addToEnergySystemModel:[2,2,1,""],getDataForTimeSeriesAggregation:[2,2,1,""],getTSAOutput:[2,2,1,""],prepareTSAInput:[2,2,1,""],setAggregatedTimeSeriesData:[2,2,1,""],setTimeSeriesData:[2,2,1,""]},"component.ComponentModel":{bigM:[2,2,1,""],capToNbInt:[2,2,1,""],capToNbReal:[2,2,1,""],capacityFix:[2,2,1,""],capacityMinDec:[2,2,1,""],declareBinaryDesignDecisionVars:[2,2,1,""],declareCapacityVars:[2,2,1,""],declareComponentConstraints:[2,2,1,""],declareContinuousDesignVarSet:[2,2,1,""],declareDesignDecisionVarSet:[2,2,1,""],declareDesignVarSet:[2,2,1,""],declareDiscreteDesignVarSet:[2,2,1,""],declareIntNumbersVars:[2,2,1,""],declareOpVarSet:[2,2,1,""],declareOperationVars:[2,2,1,""],declareRealNumbersVars:[2,2,1,""],declareSets:[2,2,1,""],declareVariables:[2,2,1,""],designBinFix:[2,2,1,""],getCommodityBalanceContribution:[2,2,1,""],getObjectiveFunctionContribution:[2,2,1,""],getOptimalValues:[2,2,1,""],getSharedPotentialContribution:[2,2,1,""],operationMode1:[2,2,1,""],operationMode2:[2,2,1,""],operationMode3:[2,2,1,""],operationMode4:[2,2,1,""],operationMode5:[2,2,1,""]},"conversion.Conversion":{__init__:[4,2,1,""],addToEnergySystemModel:[4,2,1,""],getDataForTimeSeriesAggregation:[4,2,1,""],setAggregatedTimeSeriesData:[4,2,1,""],setTimeSeriesData:[4,2,1,""]},"conversion.ConversionModel":{declareComponentConstraints:[4,2,1,""],declareSets:[4,2,1,""],declareVariables:[4,2,1,""],getCommodityBalanceContribution:[4,2,1,""],getObjectiveFunctionContribution:[4,2,1,""],getOptimalValues:[4,2,1,""],getSharedPotentialContribution:[4,2,1,""],linkedCapacity:[4,2,1,""]},"energySystemModel.EnergySystemModel":{__init__:[5,2,1,""],add:[5,2,1,""],cluster:[5,2,1,""],declareCommodityBalanceConstraints:[5,2,1,""],declareObjective:[5,2,1,""],declareOptimizationProblem:[5,2,1,""],declareTimeSets:[5,2,1,""],getComponent:[5,2,1,""],getComponentAttribute:[5,2,1,""],getOptimizationSummary:[5,2,1,""],optimize:[5,2,1,""]},"lopf.LOPFModel":{basePhaseAngle:[10,2,1,""],declareComponentConstraints:[10,2,1,""],declareSets:[10,2,1,""],declareVariables:[10,2,1,""],getCommodityBalanceContribution:[10,2,1,""],getObjectiveFunctionContribution:[10,2,1,""],getOptimalValues:[10,2,1,""],getSharedPotentialContribution:[10,2,1,""],initPhaseAngleVarSet:[10,2,1,""],powerFlowDC:[10,2,1,""]},"lopf.LinearOptimalPowerFlow":{__init__:[10,2,1,""],addToEnergySystemModel:[10,2,1,""]},"sourceSink.Sink":{__init__:[13,2,1,""]},"sourceSink.Source":{__init__:[13,2,1,""],addToEnergySystemModel:[13,2,1,""],getDataForTimeSeriesAggregation:[13,2,1,""],setAggregatedTimeSeriesData:[13,2,1,""],setTimeSeriesData:[13,2,1,""]},"sourceSink.SourceSinkModel":{declareComponentConstraints:[13,2,1,""],declareSets:[13,2,1,""],declareVariables:[13,2,1,""],getCommodityBalanceContribution:[13,2,1,""],getObjectiveFunctionContribution:[13,2,1,""],getOptimalValues:[13,2,1,""],getSharedPotentialContribution:[13,2,1,""],yearlyLimitationConstraint:[13,2,1,""]},"storage.Storage":{__init__:[14,2,1,""],addToEnergySystemModel:[14,2,1,""],getDataForTimeSeriesAggregation:[14,2,1,""],setAggregatedTimeSeriesData:[14,2,1,""],setTimeSeriesData:[14,2,1,""]},"storage.StorageModel":{connectInterPeriodSOC:[14,2,1,""],connectSOCs:[14,2,1,""],cyclicLifetime:[14,2,1,""],cyclicState:[14,2,1,""],declareComponentConstraints:[14,2,1,""],declareSets:[14,2,1,""],declareVariables:[14,2,1,""],equalInterSOC:[14,2,1,""],getCommodityBalanceContribution:[14,2,1,""],getObjectiveFunctionContribution:[14,2,1,""],getOptimalValues:[14,2,1,""],getSharedPotentialContribution:[14,2,1,""],intraSOCstart:[14,2,1,""],limitSOCwithSimpleTsa:[14,2,1,""],minSOC:[14,2,1,""],minSOCwithTSAprecise:[14,2,1,""],operationModeSOC:[14,2,1,""],operationModeSOCwithTSA:[14,2,1,""]},"transmission.Transmission":{__init__:[15,2,1,""],addToEnergySystemModel:[15,2,1,""],getDataForTimeSeriesAggregation:[15,2,1,""],setAggregatedTimeSeriesData:[15,2,1,""],setTimeSeriesData:[15,2,1,""]},"transmission.TransmissionModel":{declareComponentConstraints:[15,2,1,""],declareSets:[15,2,1,""],declareVariables:[15,2,1,""],getCommodityBalanceContribution:[15,2,1,""],getObjectiveFunctionContribution:[15,2,1,""],getOptimalValues:[15,2,1,""],getSharedPotentialContribution:[15,2,1,""],operationMode1_2dim:[15,2,1,""],symmetricalCapacity:[15,2,1,""]},component:{Component:[2,1,1,""],ComponentModel:[2,1,1,""]},conversion:{Conversion:[4,1,1,""],ConversionModel:[4,1,1,""]},energySystemModel:{EnergySystemModel:[5,1,1,""]},lopf:{LOPFModel:[10,1,1,""],LinearOptimalPowerFlow:[10,1,1,""]},sourceSink:{Sink:[13,1,1,""],Source:[13,1,1,""],SourceSinkModel:[13,1,1,""]},standardIO:{energySystemModelRunFromExcel:[11,3,1,""],getDualValues:[11,3,1,""],getShadowPrices:[11,3,1,""],plotLocationalColorMap:[11,3,1,""],plotLocations:[11,3,1,""],plotOperation:[11,3,1,""],plotOperationColorMap:[11,3,1,""],plotTransmission:[11,3,1,""],readEnergySystemModelFromExcel:[11,3,1,""],writeOptimizationOutputToExcel:[11,3,1,""]},storage:{Storage:[14,1,1,""],StorageModel:[14,1,1,""]},transmission:{Transmission:[15,1,1,""],TransmissionModel:[15,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"1dim":2,"1e3":11,"1e6":[2,4,13,14,15],"1e9":5,"20energi":[],"20system":[],"20workflow":[],"2dim":2,"abstract":[2,4,13,14,15],"boolean":[2,4,5,11,13,14,15],"case":[2,4,13,14,15],"class":[3,11,12],"default":[2,4,5,11,13,14,15],"export":13,"float":[2,4,11,13,14,15],"function":[2,4,5,10,11,12,13,14,15],"import":13,"int":11,"j\u00fclich":0,"lin\u00dfen":9,"new":0,"public":7,"return":[2,4,5,10,11,13,14,15],"short":14,"true":[2,4,5,10,11,13,14,15],"while":7,For:[3,5],Has:2,The:[0,2,3,4,5,7,10,12,13,14,15],Then:[],There:3,These:[3,5],Used:2,With:[5,7],__init__:[2,4,5,10,13,14,15],_node:[],_process:[],about:7,absolut:[4,5,13,14,15],access:5,accord:0,acknowledg:7,add:[2,4,5,10,13,14,15],added:[2,3,4,5,10,11,13,14,15],adding:[2,5],addit:[2,5],addition:10,addtoenergysystemmodel:[2,4,10,13,14,15],advanc:5,after:[2,4,13,14,15],again:5,aggreat:[2,4,13,14,15],aggreg:[2,4,5,7,13,14,15],aka:2,algorithm:5,all:[2,3,4,5,10,11,13,14,15],allow:13,along:[],alpha:11,alreadi:[2,4,10,13,14,15],also:[2,13,15],altern:8,analys:0,analysi:0,angl:10,annual:[2,4,5,7,13,14,15],annuiti:2,anoth:[2,4,10,13,14,15],appli:[2,4,7,13,14,15],applic:2,area:11,areafactor:11,argument:[2,4,5,10,13,14,15],aris:[2,5],articl:7,artifici:2,assess:0,assign:[4,5,14],associ:1,assum:2,atmospher:13,attribut:5,attributenam:5,august:5,author:[4,5],avail:[2,5,11],averag:5,avoid:2,axi:11,backward:15,balanc:[0,2,4,5,10,13,14,15],base:[2,5,7],basephaseangl:10,basic:[2,3,5,11,15],befor:[5,14,15],begin:[5,14],behavior:[3,10],being:15,belong:[0,5],below:[2,4,5,10,11,13,14,15],benefit:14,besid:7,best:5,between:[0,2,10,14,15],bigm:[2,4,10,13,14,15],billion:5,binari:[2,11],bioga:2,black:11,both:15,bound:2,boundari:13,broken:5,build:[5,11],built:[2,5],burn:13,cabl:2,call:[3,5,11],can:[2,3,4,5,7,13,14,15],cannot:14,capabilit:[],capabl:6,capac:[2,4,5,10,11,13,14,15],capacityfix:[2,4,10,13,14,15],capacitymax:[2,4,10,13,14,15],capacitymin:[2,4,10,13,14,15],capacitymindec:2,capacityperplantunit:[2,4,10,13,14,15],capacityvari:[2,4,10,11,13,14,15],capacityvariabledomain:[2,4,10,13,14,15],capacityvariablesoptimum:11,captonbint:2,captonbr:2,captur:15,categor:[],cavern:14,cell:4,certain:[13,15],chain:0,chang:14,charg:14,chargeeffici:14,chargeoperationvariablesoptimum:14,chargeopr:14,chargeopratefix:14,chargeopratemax:14,charger:14,chargetsaweight:14,check:[2,4],checkout:11,chemic:13,chemicalcomponentlimitid:13,chosen:[2,5],cite:7,climat:0,clone:8,cluster:[2,5],clustermethod:5,cmap:11,co2:[2,13],coal:13,code:12,coeffici:5,coincid:13,collect:2,color:11,column:[4,10,11,13,14,15],com:[5,7,8],combin:15,come:15,command:8,commod:[2,4,5,7,10,13,14,15],commoditiylimitid:13,commoditybalanceconstraint:11,commodityconversionfactor:4,commoditycost:13,commoditylimitid:13,commodityrevenu:13,commodityunit:[2,13,14,15],commodityunitsdict:5,compar:[0,14],complex:7,compnam:11,compon:[4,5,10,11,12,13,14,15],componentclassdoc:[],componentmodel:[2,3,4,10,13,14,15],componentmodelingdict:5,componentnam:5,comput:[2,5,7,8],concret:5,conduct:0,connect:[2,14,15],connectinterperiodsoc:14,connectsoc:14,consid:[2,4,5,7,10,11,13,14,15],consider:2,consist:[2,4],consol:5,constitut:5,constraint:[2,4,5,7,10,11,13,14,15],constrnam:[2,15],constrsetnam:[2,15],constructor:[2,4,5,10,13,14,15],consum:[4,13],contain:[5,11],content:[7,12],continu:[2,4,10,13,14,15],contribut:[1,2,4,5,10,13,14,15],control:14,convent:2,convers:[2,3,5,10,12,15],conversionmodel:[3,4],convert:[2,4],coordin:11,copi:8,copyright:9,core:5,corecomponentsdoc:[],correspond:[2,7],cost:[0,2,4,5,7,13,14,15],costunit:5,could:13,countri:13,cours:5,creat:[2,4,5,10,13,14,15],crs:11,current:[0,5],curv:5,cycl:14,cyclic:14,cycliclifetim:14,cyclicst:14,dai:[5,11],daili:14,data:[0,2,3,4,5,11,13,14,15],datafram:[2,4,10,13,14,15],decis:2,declar:[2,4,5,10,13,14,15],declarebinarydesigndecisionvar:2,declarecapacityvar:2,declarecommoditybalanceconstraint:5,declarecomponentconstraint:[2,4,10,13,14,15],declarecontinuousdesignvarset:2,declaredesigndecisionvarset:2,declaredesignvarset:2,declarediscretedesignvarset:2,declareintnumbersvar:2,declareobject:5,declareoperationvar:2,declareoptimizationproblem:5,declareopvarset:2,declarerealnumbersvar:2,declareset:[2,4,10,13,14,15],declaresoptimizationproblem:5,declaretimeset:5,declarevari:[2,4,10,13,14,15],defin:[2,3,4,5,14,15],depart:0,depend:[4,5,10,13,14,15],depreci:2,deriv:5,describ:[4,10,12,13,14,15],descript:[2,4,5,7,10,11,13,14,15],design:[0,2,4,5,10,13,14,15],designbinfix:2,detail:5,determin:[0,2,14],detlef:9,develop:0,diagram:[2,4,10,13,14,15],dict:2,dictionari:[2,4,5,10,13,14,15],differenti:13,dimens:2,direct:15,directli:[4,8,13,14,15],directori:5,discharg:14,dischargeeffici:14,dischargeoperationvariablesoptimum:14,dischargeopr:14,dischargeopratefix:14,dischargeopratemax:14,discharger:14,dischargetsaweight:14,discret:[2,5],displai:5,distanc:[10,15],divid:2,doc:[2,4,10,13,14,15],document:5,doe:2,dollar:[2,4,13,14,15],domain:2,done:[2,5],doprecisetsamodel:14,dosum:11,dot:11,down:5,download:8,dpi:11,drop:[5,11,14],dual:11,dualvalu:11,due:2,durat:5,dure:[5,13,14,15],each:[2,4,5,10,11,13,14,15],econom:2,economiclifetim:[2,4,10,13,14,15],edg:11,edgecolor:11,edit:[4,5],effici:[4,14],either:[2,4,13,14,15],electr:[2,4,13],electrochem:0,electrolyz:[2,4],elig:2,els:2,emiss:0,emit:[2,13],enabl:5,end:[11,14],energi:[0,1,2,3,4,5,10,11,13,14,15],energy_system_2050:[],energysystemmodel:[2,3,4,10,11,12,13,14,15],energysystemmodelrunfromexcel:11,energyunit:14,enforc:[2,4,10,15],engin:0,ensur:2,enter:[13,14],entri:[4,13,14,15],enviroment:7,environ:[2,5,13],epsg:11,equal:[2,4,10,13,14,15],equalintersoc:14,equat:10,equival:14,error:14,esm:[2,4,10,11,13,14,15],esmdata:11,especi:14,etc:14,euro:[2,4,5,13,14,15],evalu:0,exact:5,exampl:[2,3,4,5,7,13,14],exce:14,excel:11,execut:5,exist:2,extend:3,extrem:5,face:11,facecolor:11,facilit:5,factor:[2,4,14,15],factornam:2,fals:[2,4,5,10,11,13,14,15],featur:7,feder:0,feed:13,field:1,fig:11,figsiz:11,figur:11,file:[5,11],filenam:11,fill:5,fine:[2,3,4,5,6,8,10,13,14,15],first:[7,11,15],fit:2,five:3,fix:[2,4,13,14,15],flow:[10,13,15],focus:0,folder:8,follow:7,fontsiz:11,form:[3,4,13,14,15],format:2,formul:7,forschung:[],forschungszentrum:0,forward:15,found:7,fourfold:5,framework:[0,6],free:2,from:[2,3,5,11,13,14,15],fuel:4,full:[2,4,5,7,13,14,15],further:[2,3,5],futur:0,fzj:[5,7,8,9],gas:[0,13],gener:[4,5,10,11,12,13,14,15],german:0,get:[2,4,5,10,11,13,14,15],getcommoditybalancecontribut:[2,4,10,13,14,15],getcompattr:5,getcompon:5,getcomponentattribut:5,getcwd:5,getdatafortimeseriesaggreg:[2,4,13,14,15],getdualvalu:11,getobjectivefunctioncontribut:[2,4,10,13,14,15],getoptimalvalu:[2,4,10,13,14,15],getoptimizationsummari:5,getshadowpric:11,getsharedpotentialcontribut:[2,4,10,13,14,15],gettsaoutput:2,git:8,github:[5,6,7,8],give:[7,12],given:[2,4,5,11,13,14,15],goe:13,going:15,govern:0,greenhous:0,gurobi:5,gw_el:5,gw_electr:[2,4,13],gw_h2:5,gw_hydrogen_lowerheatingvalu:4,gwh_h2_lhv:14,hand:[2,5],happen:14,has:[2,4,5,11,13,14,15],hascapacityvari:[2,4,10,13,14,15],hascapaityvari:13,hasisbuiltbinaryvari:[2,4,10,13,14,15],hastsa:[2,4,13,14,15],have:[2,3,4,10,13,14,15],heat:11,helmholtz:1,here:7,hierarch:5,hold:[2,11],home:[],home_nod:[],hour:[2,5,11,14,15],hourspertimestep:5,household:13,how:[2,5],howev:2,html:[],http:[5,7,8],hydrogen:[4,14],iek3:[5,7,8],iek:[0,9],ifbuiltbinaryvari:2,implement:[2,4,13,14,15],inch:11,includ:[0,11],independ:[2,4,10,13,14,15],index:[7,11],indexcolumn:11,indic:[2,4,5,10,11,13,14,15],inflow:14,influenc:5,inform:5,infrastructur:0,inherit:[2,3,4,5,10,13,14,15],inhert:2,initcontinuousdesignvarset:[],initdesigndecisionvarset:[],initdesignvarset:[],initdiscretedesignvarset:[],initi:[1,5,13],initopvarset:[],initphaseanglevarset:10,inject:14,input:[2,4,5,10,12,13,14,15],instal:[2,4,5,7,11,13,14,15],instanc:[2,4,5,10,11,13,14,15],institut:0,integ:[2,5,11],integr:0,interconnect:7,interdisciplinari:0,interest:2,interestr:[2,4,10,13,14,15],interperiodtimestep:5,intrasocstart:14,invest:[2,5],investifbuilt:[2,4,10,13,14,15],investig:5,investpercapac:[2,4,10,13,14,15],ipynb:[],isbuilt:2,isbuiltfix:[2,4,10,13,14,15],isbuiltvari:[2,4,10,13,14,15],isperiodicalstorag:14,isstateofcharg:2,istimeseriesdataclust:5,its:[2,5,7,14],itself:[2,5,12,14],job:5,jochen:9,join:5,joint:1,juelich:[],juli:[4,5],jupyt:[],k_mean:5,k_medoid:5,kei:[2,4,10,13,14,15],kept:11,keyword:5,kilomet:[5,11],kindli:7,kwarg:[5,11],label:11,lara:[4,5,9],larg:2,larger:[5,14],last:[4,5,11],lead:15,leav:13,legend:11,length:[5,11],lengthunit:[2,5,15],less:2,level:[5,11],licens:7,lifetim:[2,14],limit:[2,4,5,13,14,15],limitsocwithsimpletsa:14,line:[11,15],linear:[10,15],linearoptimalpowerflow:[3,12],linewidth:11,linkedcapac:4,linkedconversioncapacityid:4,list:2,literatur:7,loc0:11,loc1:11,loc:[2,4,10,11,13,14,15],local:8,locat:[2,4,5,7,8,10,11,13,14,15],location1_location2:15,location_1:[10,15],location_2:[10,15],locationalelig:[2,4,10,13,14,15],locationsshapefilenam:11,loctran:11,log:5,logfilenam:5,logtoconsol:5,lopf:10,lopfmodel:[3,10],loss:[10,15],machin:5,manag:12,map:[2,11],mark:5,market:0,martin:9,mass:0,match:[2,4,13,14,15],mathemat:2,matplotlib:11,max:14,maxdepth:[],maximum:[2,4,5,11,13,14,15],meter:11,methan:[2,13],method:[2,4,5,13,14,15],might:5,minim:[5,7],minimum:[2,5,11,14],minsoc:14,minsocwithtsaprecis:14,minu:14,mio:5,mit:9,mode:2,model:[2,3,4,5,7,10,11,13,14,15],modelingclass:[2,5],modul:[5,7,12],more:5,much:2,multi:[],multipl:[2,5,7,13],multipli:[2,4,13,14,15],must:5,name:[2,4,5,10,11,13,14,15],nan:5,nation:[5,13],natur:13,nbperiod:11,nbtimestepsperperiod:11,necessari:2,neg:[4,13],never:2,node:10,none:[2,4,5,10,11,13,14,15],note:[5,13],notebook:[],notimplementederror:[2,4,13,14,15],notypicalperiod:5,novemb:5,nper:11,number:[2,5,11,14],numberoftimestep:5,numberoftimestepsperperiod:5,numberoftypicalperiod:5,numer:5,object:[2,4,5,10,13,14,15],obtain:[2,4,5,11,13,14,15],onc:5,one:[2,4,5,10,13,14,15],onli:[2,5,11],opensourc:[],oper:[2,4,5,10,11,13,14,15],operationmode1:2,operationmode1_2dim:15,operationmode2:2,operationmode3:2,operationmode4:2,operationmode5:2,operationmodesoc:14,operationmodesocwithtsa:14,operationratefix:[4,10,13,15],operationratemax:[4,10,13,15],operationvariablesoptimum:[2,4,10,11,13,15],opexifbuilt:[2,4,10,13,14,15],opexpercapac:[2,4,10,13,14,15],opexperchargeoper:14,opexperdischargeoper:14,opexperoper:[4,10,13,14,15],optim:[2,4,5,7,10,11,13,14,15],optimalitytol:5,optimizationspec:5,option:[2,5,11],optsumoutputlevel:11,optvaloutputlevel:11,opvarnam:[2,15],order:5,org:[],origin:[2,5],other:[2,4,5,15],otherwis:[2,4,5,13,14,15],our:0,out:13,outflow:14,output:[2,5,12],outputfilenam:11,outputlevel:5,over:[2,13,15],overal:13,overreach:5,packag:[2,5,7],page:[6,7],panda:[2,4,10,11,13,14,15],param:11,paramet:[2,4,5,10,11,13,14,15],path:[5,11],pdf:5,per:[2,5,11,13,15],perarea:11,percentag:14,perform:0,period:[5,7,11,14],periodsoccurr:5,periodsord:5,perspect:2,phase:10,phaseanglevariablesoptimum:10,physic:4,physicalunit:[2,4,14],pii:7,pip:8,plant:[2,4,13],pleas:[5,7],plot:11,plotloc:11,plotlocationalcolormap:11,plotlocnam:11,plotoper:11,plotoperationcolormap:11,plottransmiss:11,plu:14,png:11,point:15,posit:[2,4,5,11,13,14,15],possibl:[2,15],post:5,potenti:[2,4,10,13,14,15],power:[2,10,13],powerflowdc:10,powerunit:14,precis:14,preparetsainput:2,previous:5,price:11,prioriti:0,problem:[2,5,11],process:[0,2,5,13],produc:[4,13],profil:5,program:[],prompt:8,proport:[4,13,14,15],protect:5,provid:[2,5,7],publish:7,purchas:13,pure:2,put:4,pym:[2,4,5,10,11,13,14,15],pyomo:[2,5,10,11],python:[5,7,8],quantit:5,rais:[2,4,13,14,15],rang:5,rate:[2,4,13,14,15],ratefix:2,ratemax:2,ratenam:2,rateweight:2,ratio:14,reach:2,reactanc:10,read:11,readenergysystemmodelfromexcel:11,real:2,reason:5,receiv:[],reduc:7,reduct:0,refer:[4,5,10,11,14,15],reformat:2,region:7,rel:[4,13,14,15],relat:[0,2,4,5,13,14,15],relev:[2,14],remain:2,repositori:8,repres:[2,4,5,10,13,14,15],represent:[5,7],requir:[2,4,5,10,11,13,14,15],research:[0,1],reset:5,resolut:[5,7,11],respect:[2,3,4,5,10,13,14,15],restrain:14,restrict:5,result:[0,5],revenu:13,robiniu:9,row:[4,5,10,13,14,15],run:[5,11,14],runtim:5,s036054421830879x:7,salt:14,same:[2,4,10,13,14,15],save:11,scalar:11,scale:5,scenarioinput:11,scenariooutput:11,scienc:7,sciencedirect:7,script:5,search:[0,7],second:[2,5,11,15],secur:0,see:[5,11,13],select:[5,14],self:14,selfdischarg:14,separ:[5,15],sequenc:5,seri:[2,4,5,7,11,13,14,15],serv:5,set:[2,4,5,10,11,13,14,15],setaggregatedtimeseriesdata:[2,4,13,14,15],settimeseriesdata:[2,4,13,14,15],setup:8,shadow:11,shape:11,share:[2,4,10,13,14,15],sharedpotentialid:[2,4,10,13,14,15],should:[2,4,5,10,11,13,14,15],show:[6,10],sign:13,simpl:15,simpli:4,simplifi:14,simul:[0,5],sinc:15,sink:[3,5,12],size:11,small:[2,14],smaller:14,solut:[5,15],solv:5,solver:5,solverspec:5,sort:5,sortvalu:5,sourc:[2,3,4,5,10,11,12,14,15],sourcesink:13,sourcesinkmodel:[3,13],space:2,spatial:5,specif:[2,4,10,13,14,15],specifi:[2,4,5,10,11,13,14,15],stabil:5,stage:7,stai:14,standard:12,standardio:11,start:[5,11],state:[5,14],stateofchargemax:14,stateofchargemin:14,stateofchargeoperationvariablesoptimum:14,step:[2,4,5,7,10,11,13,14,15],stolten:9,storag:[2,3,5,7,12],storagemodel:[3,14],store:[3,5,11,14],storetsainst:5,strategi:0,strictli:[2,5],string:[2,4,5,11,13,14,15],structur:[5,12],studi:0,subclass:[2,3,4,13,14,15],subclasscomponentsdoc:[],submiss:5,suggest:5,suitabl:5,sum:[4,5,13,14,15],summar:11,summari:[5,11],suppli:0,support:[1,5,14],sustain:0,symmetricalcapac:15,system:[0,1,2,3,4,5,10,11,13,14,15],t_co2:5,tac:5,taken:13,target:[0,7],tariff:13,technic:7,technolog:[0,14],tempor:[5,7],term:14,than:[5,14],thei:[2,5,13],themselv:13,theoret:2,thi:[1,2,4,5,13,14,15],thread:5,threshold:14,thu:[2,5,14],time:[2,4,5,7,10,11,13,14,15],timelimit:5,timeseriesaggreg:5,timestepsperperiod:5,timeunit:5,tmax:11,tmin:11,toctre:[],togeth:5,tonnes_chem:13,tonnes_co2:13,too:15,total:[5,7,14],totaltimestep:5,tpye:[2,4,13,14,15],tran:15,trans_in_ij:15,trans_out_ij:15,transfer:[13,14],transform:14,transmiss:[2,3,5,10,11,12],transmissionmodel:[3,10,15],transmissionshapefilenam:11,transmit:15,transpar:11,trigger:5,tsainstanc:5,tsam:[5,7],tsamweight:13,tsaweight:[4,10,13,15],tupl:11,tupli:11,turbin:[2,13],tutori:7,two:2,txt:5,type:[5,8,11],typic:[5,7,14],typicalperiod:5,unclust:2,under:[1,14],underscor:[5,15],uniqu:2,unit:[2,4,5,13,14,15],unlimit:2,unnecessari:2,until:5,upon:5,upper:2,use:[5,7],used:[0,2,5,13],useful:5,user:5,using:[2,5,7,11,14],util:[4,13,14,15],valu:[2,4,5,10,11,13,14,15],variabl:[2,4,5,10,11,12,13,14,15],variablenam:11,variou:0,verbos:5,verboseloglevel:5,version:14,via:8,virtual:14,vmax:11,vmin:11,vsa:[5,7,8],want:7,warm:5,warmstart:5,warn:5,weight:[2,4,13,14,15],weightdict:2,welder:[4,5,9],well:[0,2,4,10,13,14,15],when:[2,4,5,11,13,14,15],where:[5,8,14,15],whether:14,which:[2,4,5,7,10,11,13,14,15],wind:[2,13],withdrawn:14,within:5,without:11,work:[1,7],write:11,writeoptimizationoutputtoexcel:11,www:7,xlabel:11,xlsx:11,year:[5,13],yearli:13,yearlylimit:13,yearlylimitationconstraint:13,ylabel:11,you:7,your:8,zero:[10,11,14,15],zip:[],zlabel:11},titles:["About Us","Acknowledgement","Component class","Components","Conversion class","EnergySystemModel class","Examples and Tutorials","Welcome to FINE\u2019s documentation!","Installation","License","LinearOptimalPowerFlow classes","Input Output Management","Python package description","Source and Sink class","Storage class","Transmission class"],titleterms:{"class":[2,4,5,10,13,14,15],about:0,acknowledg:1,assess:7,compon:[2,3],convers:4,core:[],descript:12,document:7,energi:7,energysystemmodel:5,exampl:6,extend:[],fine:7,framework:7,input:11,instal:8,integr:7,licens:9,linearoptimalpowerflow:10,manag:11,output:11,packag:12,python:12,sink:13,sourc:13,standard:11,storag:14,system:7,transmiss:15,tutori:6,welcom:7}})
\ No newline at end of file