Tutorial 52: General Creation of Element Dataframes
This Example demonstrates the capabilities of the class Dataframes_SIR3S_Model that extends SIR3S_Model be abilities to work directley with pandas dataframes. It is shown how to create dataframes containing information about elements such as Nodes, Pipes, etc. existing in a SIR 3S Model. The methods presented are not user-defined and neither efficient, but get you the most important information quickly. For more detailed methods of creating dataframes, see Tutorial 51.
Toolkit Release
[1]:
#pip install
Imports
SIR 3S Toolkit
Regular Import/Init
[ ]:
SIR3S_SIRGRAF_DIR = r"C:\3S\SIR 3S\SirGraf-90-15-00-24_Quebec-Upd2" #change to local path
[3]:
from sir3stoolkit.core import wrapper
[4]:
wrapper
[4]:
<module 'sir3stoolkit.core.wrapper' from 'C:\\Users\\aUsername\\3S\\sir3stoolkit\\src\\sir3stoolkit\\core\\wrapper.py'>
[5]:
wrapper.Initialize_Toolkit(SIR3S_SIRGRAF_DIR)
Additional Import/Init for Dataframes class
[6]:
from sir3stoolkit.mantle.dataframes import SIR3S_Model_Dataframes
[7]:
s3s = SIR3S_Model_Dataframes()
Initialization complete
Additional
[8]:
import pandas as pd
from shapely.geometry import Point
import re
import folium
from folium.plugins import HeatMap
import numpy as np
import geopandas as gpd
from shapely import wkt
import matplotlib.pyplot as plt
import contextily as cx
Open Model
[9]:
s3s.OpenModel(dbName=r"Toolkit_Tutorial52_Model.db3",
providerType=s3s.ProviderTypes.SQLite,
Mid="M-1-0-1",
saveCurrentlyOpenModel=False,
namedInstance="",
userID="",
password="")
Model is open for further operation
Calculate Model
[10]:
s3s.ExecCalculation(True) # To ensure result data
Model Calculation is complete
Generate Element Dataframes
We can use the generate_element_dataframe() method to quickly generate basic dataframes containing all instances of hydraulic element types (Node, Pipe, etc.) in a SIR 3S model.
All model_data and most result values (self.GetResultProperties_from_elementType(onlySelectedVectors=True)) for the static timestamp are included. Result values are given as floats, unless they are in vectorized form (relevant only for pipes), in that case they are strings.
The pd.Dataframe will automatically be transformed into a gpd.GeoDataFrame if a SRID is defined in the model, after a geometry column is created.
[11]:
object_types = [item for item in dir(s3s.ObjectTypes) if not (item.startswith('__') and item.endswith('__'))]
print(object_types) # Check for hydraulic elmement types
['AGSN_HydraulicProfile', 'AirVessel', 'Arrow', 'Atmosphere', 'BlockConnectionNode', 'CalcPari', 'CharacteristicLossTable', 'CharacteristicLossTable_Row', 'Circle', 'Compressor', 'CompressorTable', 'CompressorTable_Row', 'ControlEngineeringNexus', 'ControlMode', 'ControlPointTable', 'ControlPointTable_Row', 'ControlValve', 'ControlVariableConverter', 'ControlVariableConverterRSTE', 'CrossSectionTable', 'CrossSectionTable_Row', 'DPGR_DPKT_DatapointDpgrConnection', 'DPGR_DataPointGroup', 'DPKT_Datapoint', 'DamageRatesTable', 'DamageRatesTable_Row', 'DeadTimeElement', 'Demand', 'DifferentialRegulator', 'DirectionalArrow', 'DistrictHeatingConsumer', 'DistrictHeatingFeeder', 'Divider', 'DriveEfficiencyTable', 'DriveEfficiencyTable_Row', 'DrivePowerTable', 'DrivePowerTable_Row', 'EBES_FeederGroups', 'EfficiencyConverterTable', 'EfficiencyConverterTable_Row', 'ElementQuery', 'EnergyRecoveryTable', 'EnergyRecoveryTable_Row', 'EnvironmentTemp', 'FWBZ_DistrictHeatingReferenceValues', 'FlapValve', 'FlowControlUnit', 'FluidQualityParamSet', 'FluidQualityParamSet_OS', 'FluidThermalPropertyGroup', 'FreeDuct', 'FunctionGenerator', 'FunctionTable', 'FunctionTable_Row', 'GasComponent', 'GasMixture', 'GeneralSection', 'Gravitation', 'HeatExchanger', 'HeatFeederConsumerStation', 'HeaterCooler', 'Histeresis', 'House', 'Hydrant', 'Integrator', 'LAYR_Layer', 'LoadFactorTable', 'LoadFactorTable_Row', 'LogicalComparison', 'LogicalStorage', 'MeasuredVariableTable', 'MeasuredVariableTable_Row', 'MinMaxSelection', 'Multiplier', 'NetValve', 'Node', 'NonReturnValvesTable', 'NonReturnValvesTable_Row', 'NumericalDisplay', 'ObjectContainerSymbol', 'OpenContainer', 'Oval', 'PARZ_TransientCalculationParameters', 'PhaseSeparation', 'PidController', 'Pipe', 'PipeGroup', 'PipeTable', 'PipeTable_Row', 'PipeVertex', 'Polygon', 'Polyline', 'PressureRegulator', 'PressureZone', 'Pt1Controller', 'Pump', 'PumpCharTable', 'PumpCharTable_Row', 'PumpGroup', 'PumpOfPumpGroup', 'PumpSpeedTable', 'PumpSpeedTable_Row', 'RART_ControlMode', 'REGP_ControlParameters', 'RMES_DPTS_RmesInternalDataPoint', 'Rectangle', 'RegulatorsTable', 'RegulatorsTable_Row', 'ReturnTemperaturTable', 'ReturnTemperaturTable_Row', 'RoundRectangle', 'SIRGRAF', 'SPLZ_TimeSeries', 'SafetyValve', 'SetpointDevice', 'SolarCollector', 'StandPipe', 'Street', 'SummingPoint', 'SwitchInBlock', 'TemperatureTable', 'TemperatureTable_Row', 'Text', 'ThermalOutputTable', 'ThermalOutputTable_Row', 'ThermophysPropTable', 'ThermophysPropTable_Row', 'TransitionSymbol', 'Transmitter', 'TransportVariable', 'USCH_UserDefinedProperties', 'Unknown', 'VARA_ColorScale', 'VARA_ROWS_WidthOrScale', 'VRCT_ViewRectangle', 'Valve', 'ValveLiftTable', 'ValveLiftTable_Row', 'VarFlowTable', 'VarFlowTable_Row', 'VarPressureTable', 'VarPressureTable_Row', 'VentOpenCloseTable', 'VentOpenCloseTable_Row', 'VentValve', 'VentilatedPressureAirVessel', 'WBLZ_ThermalBalance', 'WeatherDataTable', 'WeatherDataTable_Row']
This function allows for little user definition the only paramters are element_type and tks of that element type to exclusively use. For more user defined dataframe creation see Tutorial 52.
Node
[12]:
(s3s.generate_element_dataframe(element_type=s3s.ObjectTypes.Node, tks=None)).head(3)
[2026-03-03 15:24:53,718] INFO in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Generating df for element type: ObjectTypes.Node ...
[2026-03-03 15:24:53,719] DEBUG in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Generating df_model_data for element type: ObjectTypes.Node ...
[2026-03-03 15:24:53,952] INFO in sir3stoolkit.mantle.dataframes: [model_data] Generating model_data dataframe for element type: ObjectTypes.Node
[2026-03-03 15:24:53,952] INFO in sir3stoolkit.mantle.dataframes: [model_data] Retrieved 517 element(s) of element type ObjectTypes.Node.
[2026-03-03 15:24:53,983] INFO in sir3stoolkit.mantle.dataframes: [Resolving model_data Properties] No properties given → using ALL model_data properties for ObjectTypes.Node.
[2026-03-03 15:24:53,985] INFO in sir3stoolkit.mantle.dataframes: [Resolving model_data Properties] Using 37 model_data properties.
[2026-03-03 15:24:53,986] INFO in sir3stoolkit.mantle.dataframes: [model_data] Retrieving model_data properties ['Name', 'Ktyp', 'Zkor', 'QmEin', 'Lfakt', 'Fkpzon', 'Fkfstf', 'Fkutmp', 'Fkfqps', 'Fkcont', 'Fk2lknot', 'Beschreibung', 'Idreferenz', 'Iplanung', 'Kvr', 'Qakt', 'Xkor', 'Ykor', 'NodeNamePosition', 'ShowNodeName', 'KvrKlartext', 'NumberOfVERB', 'HasBlockConnection', 'Tk', 'Pk', 'InVariant', 'GeometriesDiffer', 'SymbolFactor', 'bz.Drakonz', 'bz.Fk', 'bz.Fkpvar', 'bz.Fkqvar', 'bz.Fklfkt', 'bz.PhEin', 'bz.Tm', 'bz.Te', 'bz.PhMin'], geometry...
[2026-03-03 15:24:56,899] INFO in sir3stoolkit.mantle.dataframes: [model_data] Transforming DataFrame to GeoDataFrame successful with EPSG: 25832
[2026-03-03 15:24:56,899] INFO in sir3stoolkit.mantle.dataframes: [model_data] Done. Shape: (517, 39)
[2026-03-03 15:24:57,166] DEBUG in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Generating df_results for element type: ObjectTypes.Node; at timestamp: 2023-02-13 00:00:00.000 +01:00 ...
[2026-03-03 15:24:57,166] INFO in sir3stoolkit.mantle.dataframes: [results] Generating results dataframe for element type: ObjectTypes.Node
[2026-03-03 15:24:57,485] INFO in sir3stoolkit.mantle.dataframes: [Resolving Timestamps] Only static timestamp 2023-02-13 00:00:00.000 +01:00 is used
[2026-03-03 15:24:57,489] INFO in sir3stoolkit.mantle.dataframes: [Resolving Timestamps] 1 valid timestamp(s) will be used.
[2026-03-03 15:24:57,496] INFO in sir3stoolkit.mantle.dataframes: [Resolving tks] Retrieved 517 element(s) of element type ObjectTypes.Node.
[2026-03-03 15:24:57,504] INFO in sir3stoolkit.mantle.dataframes: [results] Using 73 result properties.
[2026-03-03 15:24:57,555] INFO in sir3stoolkit.mantle.dataframes: [results] Retrieving result values...
[2026-03-03 15:25:04,916] INFO in sir3stoolkit.mantle.dataframes: [results] 26884 fully NaN columns dropped.
[2026-03-03 15:25:05,311] INFO in sir3stoolkit.mantle.dataframes: [results] Done. Shape: (1, 10857)
[2026-03-03 15:25:05,311] DEBUG in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Merging df_model_data with df_results for element type: ObjectTypes.Node ...
[12]:
| tk | Name | Ktyp | Zkor | QmEin | Lfakt | Fkpzon | Fkfstf | Fkutmp | Fkfqps | Fkcont | Fk2lknot | Beschreibung | Idreferenz | Iplanung | Kvr | Qakt | Xkor | Ykor | NodeNamePosition | ShowNodeName | KvrKlartext | NumberOfVERB | HasBlockConnection | Tk | Pk | InVariant | GeometriesDiffer | SymbolFactor | bz.Drakonz | bz.Fk | bz.Fkpvar | bz.Fkqvar | bz.Fklfkt | bz.PhEin | bz.Tm | bz.Te | bz.PhMin | geometry | BCIND | DP | DPH | H | HMAX_INST | HMIN_INST | IAKTIV | LFAKTAKT | P | PDAMPF | PH | PHMINMAXDIF | PH_EIN | PH_MIN | PMAX_INST | PMIN_INST | QM | RHO | T | TTR | VOLD | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 0 | 4612618373909997110 | V-K2133S | QKON | 543.56 | 0 | 1 | 5520728169779652386 | 4798673252636751115 | 5591325053703727727 | -1 | 5029128874972463118 | 5611267768413515094 | Anfangsknoten generiert von SirDB | 3S96AE619D388EA6F4CC9F24456148E088 | 1 | 1 | 0 | 714332.858074 | 5.578924e+06 | 1 | False | Vorlauf | 0 | False | 4612618373909997110 | 4612618373909997110 | False | False | 0.2 | 0 | 4612618373909997110 | -1 | -1 | -1 | 0 | 0 | 0 | 0 | POINT (714332.858 5578924.328) | 17.0 | 0.00786 | 0.00786 | 1.121165 | 1.121165 | 1.121165 | 1.0 | 1.0 | 1.772049 | 0.0123 | 0.772049 | 0.00000 | 0.772049 | 0.0 | 1.772049 | 1.772049 | 0.0 | 1000.3 | 10.0000 | 0.000000 | 0.0 |
| 1 | 4619205996903908050 | V-K983S | QKON | 548.26 | 0 | 1 | 5520728169779652386 | 4798673252636751115 | 5591325053703727727 | -1 | 5029128874972463118 | 5130743098019975840 | Anfangsknoten generiert von SirDB | 3S56C0B9A1652EF8E9B7AB8C5DEACA2DC4 | 1 | 1 | 0 | 713611.070733 | 5.578598e+06 | 1 | False | Vorlauf | 0 | False | 4619205996903908050 | 4619205996903908050 | False | False | 0.2 | 0 | 4619205996903908050 | -1 | -1 | -1 | 0 | 0 | 0 | 0 | POINT (713611.071 5578598.067) | 17.0 | -103.87130 | -103.87130 | -77.653320 | -77.653320 | -77.653320 | 0.0 | 1.0 | -77.463350 | 15.5488 | -78.463350 | -78.46335 | -78.463350 | 0.0 | -77.463350 | -77.463350 | 0.0 | 865.2 | 665.8970 | 0.015023 | 0.0 |
| 2 | 4619682681341516951 | R-K2803S | QKON | 554.99 | 0 | 1 | 5520728169779652386 | 4798673252636751115 | 5591325053703727727 | -1 | 5029128874972463118 | 5367059433340055050 | Anfangsknoten generiert von SirDB | 3S7BD49C919428AD75D6EA1203195E860E | 1 | 2 | 0 | 713542.639481 | 5.578805e+06 | 1 | False | Rücklauf | 0 | False | 4619682681341516951 | 4619682681341516951 | False | False | 0.2 | 0 | 4619682681341516951 | -1 | -1 | -1 | 0 | 0 | 0 | 0 | POINT (713542.639 5578804.842) | 17.0 | -93.81168 | -93.81168 | 21.135280 | 21.135280 | 21.135280 | 0.0 | 1.0 | 20.665260 | 15.5488 | 19.665260 | 0.00000 | 19.665260 | 0.0 | 20.665260 | 20.665260 | 0.0 | 865.2 | 662.4618 | 0.000000 | 0.0 |
Pipe
[13]:
(s3s.generate_element_dataframe(element_type=s3s.ObjectTypes.Pipe, tks=None)).head(3)
[2026-03-03 15:25:05,404] INFO in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Generating df for element type: ObjectTypes.Pipe ...
[2026-03-03 15:25:05,406] DEBUG in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Generating df_model_data for element type: ObjectTypes.Pipe ...
[2026-03-03 15:25:05,568] INFO in sir3stoolkit.mantle.dataframes: [model_data] Generating model_data dataframe for element type: ObjectTypes.Pipe
[2026-03-03 15:25:05,568] INFO in sir3stoolkit.mantle.dataframes: [model_data] Retrieved 524 element(s) of element type ObjectTypes.Pipe.
[2026-03-03 15:25:05,577] INFO in sir3stoolkit.mantle.dataframes: [Resolving model_data Properties] No properties given → using ALL model_data properties for ObjectTypes.Pipe.
[2026-03-03 15:25:05,579] INFO in sir3stoolkit.mantle.dataframes: [Resolving model_data Properties] Using 46 model_data properties.
[2026-03-03 15:25:05,580] INFO in sir3stoolkit.mantle.dataframes: [model_data] Retrieving model_data properties ['Name', 'FkdtroRowd', 'Fkltgr', 'Fkstrasse', 'L', 'Lzu', 'Rau', 'Jlambs', 'Lambda0', 'Zein', 'Zaus', 'Zuml', 'Asoll', 'Indschall', 'Baujahr', 'Hal', 'Fkcont', 'Fk2lrohr', 'Beschreibung', 'Idreferenz', 'Iplanung', 'Kvr', 'LineWidthMM', 'DottedLine', 'DN', 'Di', 'KvrKlartext', 'HasClosedNSCHs', 'Tk', 'Pk', 'InVariant', 'Xkor', 'Ykor', 'GeometriesDiffer', 'bz.Fk', 'bz.Qsvb', 'bz.Irtrenn', 'bz.Leckstatus', 'bz.Leckstart', 'bz.Leckend', 'bz.Leckort', 'bz.Leckmenge', 'bz.Imptnz', 'bz.Zvlimptnz', 'bz.Kantenzv', 'bz.ITrennWithNSCH'], geometry, end nodes...
[2026-03-03 15:25:07,256] INFO in sir3stoolkit.mantle.dataframes: [model_data] 2 non-empty end node columns were created.
[2026-03-03 15:25:07,431] INFO in sir3stoolkit.mantle.dataframes: [model_data] Transforming DataFrame to GeoDataFrame successful with EPSG: 25832
[2026-03-03 15:25:07,431] INFO in sir3stoolkit.mantle.dataframes: [model_data] Done. Shape: (524, 50)
[2026-03-03 15:25:07,501] DEBUG in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Generating df_results for element type: ObjectTypes.Pipe; at timestamp: 2023-02-13 00:00:00.000 +01:00 ...
[2026-03-03 15:25:07,501] INFO in sir3stoolkit.mantle.dataframes: [results] Generating results dataframe for element type: ObjectTypes.Pipe
[2026-03-03 15:25:07,566] INFO in sir3stoolkit.mantle.dataframes: [Resolving Timestamps] Only static timestamp 2023-02-13 00:00:00.000 +01:00 is used
[2026-03-03 15:25:07,566] INFO in sir3stoolkit.mantle.dataframes: [Resolving Timestamps] 1 valid timestamp(s) will be used.
[2026-03-03 15:25:07,573] INFO in sir3stoolkit.mantle.dataframes: [Resolving tks] Retrieved 524 element(s) of element type ObjectTypes.Pipe.
[2026-03-03 15:25:07,575] INFO in sir3stoolkit.mantle.dataframes: [results] Using 82 result properties.
[2026-03-03 15:25:07,598] INFO in sir3stoolkit.mantle.dataframes: [results] Retrieving result values...
[2026-03-03 15:25:13,201] INFO in sir3stoolkit.mantle.dataframes: [results] 26724 fully NaN columns dropped.
[2026-03-03 15:25:14,794] INFO in sir3stoolkit.mantle.dataframes: [results] Done. Shape: (1, 16244)
[2026-03-03 15:25:14,797] DEBUG in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Merging df_model_data with df_results for element type: ObjectTypes.Pipe ...
[13]:
| tk | Name | FkdtroRowd | Fkltgr | Fkstrasse | L | Lzu | Rau | Jlambs | Lambda0 | Zein | Zaus | Zuml | Asoll | Indschall | Baujahr | Hal | Fkcont | Fk2lrohr | Beschreibung | Idreferenz | Iplanung | Kvr | LineWidthMM | DottedLine | DN | Di | KvrKlartext | HasClosedNSCHs | Tk | Pk | InVariant | Xkor | Ykor | GeometriesDiffer | bz.Fk | bz.Qsvb | bz.Irtrenn | bz.Leckstatus | bz.Leckstart | bz.Leckend | bz.Leckort | bz.Leckmenge | bz.Imptnz | bz.Zvlimptnz | bz.Kantenzv | bz.ITrennWithNSCH | geometry | fkKI | fkKK | A | DTTR | DWVERL | DWVERLABS | IAKTIV | IRTRENN | JV | MVEC_start | MVEC_end | MVEC_sequence | PDAMPF | PHR | PMIN | PVEC_start | PVEC_end | PVEC_sequence | PVECMAX_INST_start | PVECMAX_INST_end | PVECMAX_INST_sequence | PVECMIN_INST_start | PVECMIN_INST_end | PVECMIN_INST_sequence | QMAV | QMI | QMK | RHOI | RHOK | RHOVEC_start | RHOVEC_end | RHOVEC_sequence | SVEC_start | SVEC_end | SVEC_sequence | TI | TK | TTRVEC_start | TTRVEC_end | TTRVEC_sequence | TVEC_start | TVEC_end | TVEC_sequence | VAV | VI | VK | VOLDA | WVL | ZVEC_start | ZVEC_end | ZVEC_sequence | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 0 | 4614463970292122863 | Rohr R-K4383S R-K4183S | 4689226368751411179 | 4779752876656844188 | 5431845028903382031 | 7.780674 | 0 | 0.05 | 1 | 0 | 0 | 0 | 0 | 1000 | 0 | 0 | 5029128874972463118 | 4713734746689397424 | OSM: Knoten 450994211 -> Knoten 476971188; Län... | 166815824 | 5 | 2 | 0.005 | 0 | 999 | 994.0 | Rücklauf | 4614463970292122863 | 4614463970292122863 | False | 714262.482930 | 5.578857e+06 | False | 4614463970292122863 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | LINESTRING (714262.483 5578857.42, 714269.543 ... | 4730066059089961857 | 4917189080965035120 | 0.0 | 0.0 | 0.0 | 0.0 | 1.0 | 0.0 | 0.0 | -4.292815e-10 | -4.292815e-10 | (-4.292815e-10, -4.292815e-10) | 0.0123 | 0.0 | 1.615081 | 1.61508 | 1.688655 | (1.61508, 1.688655) | 1.61508 | 1.688655 | (1.61508, 1.688655) | 1.61508 | 1.688655 | (1.61508, 1.688655) | -0.0 | -0.0 | -0.0 | 1000.3 | 1000.3 | 1000.3 | 1000.3 | (1000.3, 1000.3) | 0.0 | 7.780674 | (0.0, 7.780674) | 9.999994 | 9.999994 | 0.0000 | 7.780674 | (0.0, 7.780674) | 10.0 | 10.0 | (10.0, 10.0) | -0.0 | -0.0 | -0.0 | 0.0 | 0.0 | 545.09 | 544.34 | (545.09, 544.34) | ||
| 1 | 4615723899944629797 | Rohr V-K203S V-K213S | 4689226368751411179 | 4779752876656844188 | 5728726059620036726 | 64.287240 | 0 | 0.05 | 1 | 0 | 0 | 0 | 0 | 1000 | 0 | 0 | 5029128874972463118 | 4938076287810941486 | OSM: Knoten 390310977 -> Knoten 1368674233; Lä... | 24633100 | 5 | 1 | 0.005 | 0 | 999 | 994.0 | Vorlauf | 4615723899944629797 | 4615723899944629797 | False | 713738.296567 | 5.579220e+06 | False | 4615723899944629797 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | LINESTRING (713738.297 5579219.902, 713793.23 ... | 5129584372458662150 | 5332825919690090061 | 0.0 | 0.0 | 0.0 | 0.0 | 1.0 | 0.0 | 0.0 | 2.582965e-09 | 2.582965e-09 | (2.582965e-09, 2.582965e-09, 2.582965e-09, 2.5... | 0.0123 | 0.0 | -74.2059 | -74.20590 | -73.920440 | (-74.2059, -74.16512, -74.12434, -74.08356, -7... | -74.20590 | -73.920440 | (-74.2059, -74.16512, -74.12434, -74.08356, -7... | -74.20590 | -73.920440 | (-74.2059, -74.16512, -74.12434, -74.08356, -7... | 0.0 | 0.0 | 0.0 | 1000.3 | 1000.3 | 1000.3 | 1000.3 | (1000.3, 1000.3, 1000.3, 1000.3, 1000.3, 1000.... | 0.0 | 64.287240 | (0.0, 9.183891, 18.36778, 27.55167, 36.73557, ... | 9.999994 | 9.999994 | 107.3669 | 43.079700 | (107.3669, 98.18304, 88.99916, 79.81527, 70.63... | 10.0 | 10.0 | (10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0) | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 565.84 | 562.93 | (565.84, 565.4243, 565.0086, 564.5929, 564.177... | ||
| 2 | 4621030304810285220 | Rohr R-K2573S R-K2583S | 5516336706687055417 | 4779752876656844188 | 5644881417512616095 | 3.956838 | 0 | 0.05 | 1 | 0 | 0 | 0 | 0 | 1000 | 0 | 0 | 5029128874972463118 | 5625716875961234775 | OSM: Knoten 476971211 -> Knoten 264607350; Län... | 24386111 | 0 | 2 | 0.005 | 0 | 100 | 107.1 | Rücklauf | 4621030304810285220 | 4621030304810285220 | False | 713650.613400 | 5.578990e+06 | False | 4621030304810285220 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | LINESTRING (713650.613 5578990.488, 713649.498... | 5070795580168283912 | 5725848577942138606 | 0.0 | 3.956838 | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 1.680974e-08 | 1.680974e-08 | (1.680974e-08, 1.680974e-08) | 0.0123 | 0.0 | 19.86233 | 19.87508 | 19.862340 | (19.87508, 19.86234) | 19.87508 | 19.862340 | (19.87508, 19.86234) | 19.87508 | 19.862340 | (19.87508, 19.86234) | 0.0 | 0.0 | 0.0 | 1000.3 | 1000.3 | 1000.3 | 1000.3 | (1000.3, 1000.3) | 0.0 | 3.956838 | (0.0, 3.956838) | 9.999994 | 9.999994 | 12017.9000 | 12021.860000 | (12017.9, 12021.86) | 10.0 | 10.0 | (10.0, 10.0) | 0.0 | 0.0 | 0.0 | 0.0 | 0.0 | 563.01 | 563.14 | (563.01, 563.14) |
As can be seen some result values are in vectorized form, since pipes have result values that are calculated for interior points.
DistrictHeatingConsumer
We can specify the timestamp we want the result data for either as “2023-02-13 01:00:00.000 +01:00” or 1 meaning the second element in s3s.GetTimeStamps()[0], otherwise static is used.
[14]:
(s3s.generate_element_dataframe(element_type=s3s.ObjectTypes.DistrictHeatingConsumer, tks=None, timestamp=1)).head(3)
[2026-03-03 15:25:14,998] INFO in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Generating df for element type: ObjectTypes.DistrictHeatingConsumer ...
[2026-03-03 15:25:14,999] DEBUG in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Generating df_model_data for element type: ObjectTypes.DistrictHeatingConsumer ...
[2026-03-03 15:25:15,083] INFO in sir3stoolkit.mantle.dataframes: [model_data] Generating model_data dataframe for element type: ObjectTypes.DistrictHeatingConsumer
[2026-03-03 15:25:15,085] INFO in sir3stoolkit.mantle.dataframes: [model_data] Retrieved 337 element(s) of element type ObjectTypes.DistrictHeatingConsumer.
[2026-03-03 15:25:15,087] INFO in sir3stoolkit.mantle.dataframes: [Resolving model_data Properties] No properties given → using ALL model_data properties for ObjectTypes.DistrictHeatingConsumer.
[2026-03-03 15:25:15,087] INFO in sir3stoolkit.mantle.dataframes: [Resolving model_data Properties] Using 55 model_data properties.
[2026-03-03 15:25:15,089] INFO in sir3stoolkit.mantle.dataframes: [model_data] Retrieving model_data properties ['Name', 'Beschreibung', 'Ind0', 'W0', 'Qm0', 'Tvl0', 'Trs0', 'Lfk', 'Rho0', 'Dtmin', 'Indtr', 'Trsk', 'Fktrft', 'A', 'B', 'C', 'Vtyp', 'V0', 'P1soll', 'Dpvlmin', 'Fkzep1vl', 'Tsvl', 'Zevk', 'Dphaus', 'Dprlmin', 'Fkzep1rl', 'Tsrl', 'Imbg', 'Irfv', 'Fkcont', 'Idreferenz', 'Iplanung', 'CPM', 'NumberOfVERB', 'IndtrKlartext', 'M0Estimated', 'W0Estimated', 'Tk', 'Pk', 'InVariant', 'Xkor', 'Ykor', 'ShowDescription', 'PositionOfDescription', 'Angle', 'SymbolFactor', 'GeometriesDiffer', 'bz.Fk', 'bz.Indlast', 'bz.Indlfkt2', 'bz.Fklfkt', 'bz.Fklfkt2', 'bz.Fkqvar', 'bz.Fktevt', 'bz.IndlastKlartext'], geometry, end nodes...
[2026-03-03 15:25:16,176] INFO in sir3stoolkit.mantle.dataframes: [model_data] 2 non-empty end node columns were created.
[2026-03-03 15:25:16,312] INFO in sir3stoolkit.mantle.dataframes: [model_data] Transforming DataFrame to GeoDataFrame successful with EPSG: 25832
[2026-03-03 15:25:16,312] INFO in sir3stoolkit.mantle.dataframes: [model_data] Done. Shape: (337, 59)
[2026-03-03 15:25:16,377] DEBUG in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Generating df_results for element type: ObjectTypes.DistrictHeatingConsumer; at timestamp: 2023-02-13 01:00:00.000 +01:00 ...
[2026-03-03 15:25:16,377] INFO in sir3stoolkit.mantle.dataframes: [results] Generating results dataframe for element type: ObjectTypes.DistrictHeatingConsumer
[2026-03-03 15:25:16,465] INFO in sir3stoolkit.mantle.dataframes: [Resolving Timestamps] 1 valid timestamp(s) will be used.
[2026-03-03 15:25:16,465] INFO in sir3stoolkit.mantle.dataframes: [Resolving tks] Retrieved 337 element(s) of element type ObjectTypes.DistrictHeatingConsumer.
[2026-03-03 15:25:16,467] INFO in sir3stoolkit.mantle.dataframes: [results] Using 36 result properties.
[2026-03-03 15:25:16,474] INFO in sir3stoolkit.mantle.dataframes: [results] Retrieving result values...
[2026-03-03 15:25:17,582] INFO in sir3stoolkit.mantle.dataframes: [results] 5392 fully NaN columns dropped.
[2026-03-03 15:25:17,987] INFO in sir3stoolkit.mantle.dataframes: [results] Done. Shape: (1, 6740)
[2026-03-03 15:25:17,989] DEBUG in sir3stoolkit.mantle.dataframes: [generate_element_dataframe] Merging df_model_data with df_results for element type: ObjectTypes.DistrictHeatingConsumer ...
[14]:
| tk | Name | Beschreibung | Ind0 | W0 | Qm0 | Tvl0 | Trs0 | Lfk | Rho0 | Dtmin | Indtr | Trsk | Fktrft | A | B | C | Vtyp | V0 | P1soll | Dpvlmin | Fkzep1vl | Tsvl | Zevk | Dphaus | Dprlmin | Fkzep1rl | Tsrl | Imbg | Irfv | Fkcont | Idreferenz | Iplanung | CPM | NumberOfVERB | IndtrKlartext | M0Estimated | W0Estimated | Tk | Pk | InVariant | Xkor | Ykor | ShowDescription | PositionOfDescription | Angle | SymbolFactor | GeometriesDiffer | bz.Fk | bz.Indlast | bz.Indlfkt2 | bz.Fklfkt | bz.Fklfkt2 | bz.Fkqvar | bz.Fktevt | bz.IndlastKlartext | geometry | fkKI | fkKK | DH | DP | DPH | IAKTIV | INDUV | LFH | LFT | M | MHYUV | MTHUV | PHIRL | PHIVL | QM | RHOI | RHOK | TI | TK | TVMIN | W | WSOLL | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 0 | 4611752310942477664 | Fernwärmeverbraucher V-K1203S R-K3683S | Gattendorf;95185;Obere Au;28;None;yes | 0 | 139.0433 | 1 | 90 | 60 | 1 | 1000 | 3 | 3 | 60 | -1 | 2 | -0.25 | -2 | 1 | 1 | 0 | 0 | -1 | 0 | 0 | 0.2 | 0.3 | -1 | 0 | 0 | 1 | 5029128874972463118 | 830887238 | 1 | 4.1903 | 0 | Tabelle Temperatur TEVT, TRS(t) | 3.981862 | 34.91917 | 4611752310942477664 | 4611752310942477664 | False | 713675.300232 | 5.578705e+06 | False | 3 | 0 | 0.1 | False | 4611752310942477664 | 0 | 0 | 4835417738045943522 | -1 | -1 | 5395645951786400348 | Lastfaktor thermisch | POINT (713675.3 5578705.193) | 4673701597187411685 | 4995788945387711669 | -1525.83400 | -129.462600 | -129.462600 | 0.0 | -1.0 | 5.353562 | 0.5739 | 5.920521 | -15.39335 | -15.39335 | -3.333333e+32 | -3.333333e+32 | 21.31388 | 865.2 | 865.2 | 665.7723 | 662.7723 | 682.061 | 79.79695 | 79.79695 |
| 1 | 4612528660388965271 | Fernwärmeverbraucher V-K1783S R-K4263S | None;None;None;None;None;yes | 0 | 386.4134 | 1 | 90 | 60 | 1 | 1000 | 3 | 3 | 60 | -1 | 2 | -0.25 | -2 | 1 | 0 | 0 | 0 | -1 | 0 | 0 | 0.2 | 0.3 | -1 | 0 | 0 | 1 | 5029128874972463118 | 1056287317 | 1 | 4.1903 | 0 | Tabelle Temperatur TEVT, TRS(t) | 11.065940 | 34.91917 | 4612528660388965271 | 4612528660388965271 | False | 714251.332395 | 5.578925e+06 | False | 3 | 0 | 0.1 | False | 4612528660388965271 | 0 | 0 | 5554262436821166605 | -1 | -1 | 5395645951786400348 | Lastfaktor thermisch | POINT (714251.332 5578925.001) | 5015101891725198603 | 5751808837348052764 | 0.07012 | 0.006878 | 0.006878 | 1.0 | -1.0 | 0.000000 | 0.0000 | 0.000000 | 0.00000 | 0.00000 | -3.333333e+32 | -3.333333e+32 | 0.00000 | 1000.3 | 865.2 | 10.0000 | 666.0000 | 10.000 | 0.00000 | 0.00000 |
| 2 | 4612562908060328263 | Fernwärmeverbraucher V-K1623S R-K4103S | Gattendorf;95185;Langenbachstraße;4;None;yes | 0 | 106.6409 | 1 | 90 | 60 | 1 | 1000 | 3 | 3 | 60 | -1 | 2 | -0.25 | -2 | 1 | 1 | 0 | 0 | -1 | 0 | 0 | 0.2 | 0.3 | -1 | 0 | 0 | 1 | 5029128874972463118 | 830818182 | 1 | 4.1903 | 0 | Tabelle Temperatur TEVT, TRS(t) | 3.053936 | 34.91917 | 4612562908060328263 | 4612562908060328263 | False | 713271.271817 | 5.578980e+06 | False | 3 | 0 | 0.1 | False | 4612562908060328263 | 0 | 0 | 4835417738045943522 | -1 | -1 | 5395645951786400348 | Lastfaktor thermisch | POINT (713271.272 5578979.743) | 4965299629814639205 | 4779536530687993701 | -1511.19700 | -128.220700 | -128.220700 | 0.0 | -1.0 | 5.353756 | 0.5739 | 4.540978 | -11.80654 | -11.80654 | -3.333333e+32 | -3.333333e+32 | 16.34752 | 865.2 | 865.2 | 665.7705 | 662.7705 | 682.061 | 61.20121 | 61.20121 |