List of result methodsΒΆ

This list is not complete

[1]:

# Print attributes
from IPython.display import HTML, display
import pyltm
import pandas as pd
from importlib.metadata import version

def show_ltmapi_result_methods():
    result_methods = pyltm.LtmApiModule.results()
    frame = pd.DataFrame(result_methods)
    display(HTML(frame.to_html()))


display(f"pyltm {version("pyltm")}")

show_ltmapi_result_methods()

'pyltm 0.21.0'
what return_type name arguments description
0 battery PyltmResult sum_energy [time_axis = true # Time axis included in results.] Battery module sum energy
1 battery PyltmResult sum_power_production [time_axis = true # Time axis included in results.] Battery module sum power production
2 busbar string build_connection_tree [] Create a directed acyclic graph in GraphViz dot format
3 busbar bool have_aggregated_hydro_results [] Returns true if busbar has aggregated hydro results and is not a battery busbar. Result is only valid if the object is part of a model.
4 busbar bool have_battery_results [] Returns true if the busbar has battery results
5 busbar bool have_detailed_hydro_results [] Returns true if the busbar has detailed hydro results
6 busbar bool have_hydraulic_coupling_results [] Returns true if there are results from hydraulic couplings type 200 or type 300. Result is only valid if the object is part of a model.
7 busbar bool have_market_results [] Returns true if the busbar has market results
8 busbar bool have_water_value_results [] Returns true if the busbar has water value results
9 busbar list[HydraulicCoupling] hydraulic_couplings [] A list of hydraulic couplings connected to this busbar
10 busbar PyltmResult market_result_price [time_axis = true # Time axis included in results.] Busbar market results over time
11 busbar list[Reservoir] reservoirs [] A list of reservoirs (with plants) connected to this busbar
12 busbar PyltmResult sum_hydro_production [time_axis = true # Time axis included in results.] Busbar sum hydro production steps over time
13 busbar PyltmResult sum_load [time_axis = true # Time axis included in results.] Busbar sum load filling over time
14 busbar PyltmResult sum_power_used_for_pumping [time_axis = true # Time axis included in results.] Aggregated sum of power used to pump in the busbar
15 busbar PyltmResult sum_production_from_market_steps [time_axis = true # Time axis included in results.] Busbar sum production from market steps over time
16 busbar PyltmResult sum_pumped_power [time_axis = true # Time axis included in results.] Aggregated sum of power stored with pumping
17 busbar PyltmResult sum_reservoir [time_axis = true # Time axis included in results.] Busbar sum reservoir filling over time
18 busbar PyltmResult water_value_results [time_axis = true # Time axis included in results.] Water values for busbar
19 cne PyltmResult get_dual_values [time_axis = true # Time axis included in results.] FBMC dual values. Results are only valid with model type EMPS.
20 cne PyltmResult get_flow_values [time_axis = true # Time axis included in results.] FBMC flow values. Results are only valid with model type EMPS.
21 dcline bool have_transmission_results [] Returns true if there are valid transmission results for this DCLine
22 dcline PyltmResult transmission_results [time_axis = true # Time axis included in results.] Transmission results for DCLine
23 enmag PyltmResult sum_hydro_energy [time_axis = true # Time axis included in results.] Aggregated hydro module sum hydro energy
24 enmag PyltmResult sum_hydro_power_production [time_axis = true # Time axis included in results.] Aggregated hydro module sum hydro power production
25 hydraulic_coupling list[Reservoir] connected_reservoirs [] For a non-station joined hydraulic coupling (type 200 or 300), returns connected reservoirs.
26 hydraulic_coupling PyltmResult discharge [time_axis = true # Time axis included in results.] Hydraulic coupling discharge. Only relevant if HC is connected to a plant.
27 hydraulic_coupling bool have_hydraulic_flow_results [] Are there hydraulic flow results available for this hydraulic coupling. Only available in EOPS, and with a license enabling hydraulic flow results.
28 hydraulic_coupling PyltmResult production [time_axis = true # Time axis included in results.] Hydraulic coupling production. Only relevant if HC is connected to a plant.
29 reservoir PyltmResult bypass [time_axis = true # Time axis included in results.] Reservoir bypass over time (price segment resolution).
30 reservoir PyltmResult discharge [time_axis = true # Time axis included in results.] Reservoir discharge over time (price segment resolution).
31 reservoir PyltmResult flow [time_axis = true # Time axis included in results.] Flow exchange results for hydraulic coupling. Only available with EOPS, and a license enabling flow exchange results.
32 reservoir PyltmResult inflow [time_axis = true # Time axis included in results.] Reservoir inflow over time (price segment resolution).
33 reservoir PyltmResult production [time_axis = true # Time axis included in results.] Reservoir/plant production over time (price segment resolution).
34 reservoir PyltmResult reservoir [time_axis = true # Time axis included in results.] Reservoir filling over time (price segment resolution).
35 reservoir PyltmResult spill [time_axis = true # Time axis included in results.] Reservoir spill over time (price segment resolution).