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