List of API attributesΒΆ

The attributes in this list are subject to change without notice.

Conventions used in the desgin of the API and attributes:

For energy:

  • Use MW wherever possible.

  • MWh when MW does not make sense.

For water flow:

  • Use m3/sec wherever possible.

  • Use Mm3 when m3/sec does not make sense.

[1]:

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

def show_ltmapi_attributes():
    attributes = pyltm.LtmApiModule.attributes()
    frame = pd.DataFrame(attributes)
    display(HTML(frame.to_html()))

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

show_ltmapi_attributes()

'pyltm 0.25.2'
collection what type_name name type unit default_value description required
0 areas area Area #comment string User comment False
1 areas area Area name string Object name True
2 areas area Area metadata json User metadata False
3 areas area Area id int 0 Internal ID False
4 areas area Area water_value_weights water_value_optional Water value weights False
5 areas area Area spill_cost double_optional Spill cost price False
6 areas area Area load_penalty double_optional Load penalty price False
7 areas area Area max_iterations int_optional Max number of iterations for this Area False
8 areas area Area precision double_optional Precision for this Area False
9 areas area Area feedback_factors feedback_factors_optional Area feedback factors False
10 areas area Area has_detailed_grid bool 0 Participates in detailed grid or not False
11 batteries battery BatteryModule #comment string User comment False
12 batteries battery BatteryModule name string Object name True
13 batteries battery BatteryModule metadata json User metadata False
14 batteries battery BatteryModule area_name string Area name False
15 batteries battery BatteryModule start_battery_energy double MWh 0.00 Initial battery energy. True
16 batteries battery BatteryModule endvalue_type int 0 Endvalue type False
17 batteries battery BatteryModule max_energy_level txy MWh Max energy level True
18 batteries battery BatteryModule min_energy_level txy MWh Min energy level True
19 batteries battery BatteryModule max_discharge_power txy MW Max discharge power True
20 batteries battery BatteryModule min_discharge_power txy MW Min discharge power True
21 batteries battery BatteryModule charging_efficiency txy Factor Charging efficiency True
22 batteries battery BatteryModule max_charging_power txy MW Max charging power True
23 batteries battery BatteryModule charging_cost txy Currency Charging cost True
24 batteries battery BatteryModule exogenous_endvalue txy Currency / energy unit Exogenous endvalue False
25 bidding_zones bidding_zone BiddingZone #comment string User comment False
26 bidding_zones bidding_zone BiddingZone name string Object name True
27 bidding_zones bidding_zone BiddingZone metadata json User metadata False
28 bidding_zones bidding_zone BiddingZone is_fbmc bool Yes/No 1 Is bidding zone a part of the FBMC network False
29 bypasses bypass Bypass #comment string User comment False
30 bypasses bypass Bypass name string Object name True
31 bypasses bypass Bypass metadata json User metadata False
32 bypasses bypass Bypass min_bypass_curve txylin m3/sec Min bypass curve False
33 bypasses bypass Bypass min_bypass_series_name string string Min bypass series name False
34 bypasses bypass Bypass min_bypass_scale double factor 0.00 Min bypass scaling factor False
35 bypasses bypass Bypass max_bypass_curve txylin m3/sec Max bypass curve False
36 bypasses bypass Bypass max_bypass_series_name string string Max bypass series name False
37 bypasses bypass Bypass max_bypass_scale double factor 0.00 Max bypass scaling factor False
38 cnes cne CriticalNetworkElement #comment string User comment False
39 cnes cne CriticalNetworkElement name string Object name True
40 cnes cne CriticalNetworkElement metadata json User metadata False
41 cnes cne CriticalNetworkElement active txy time/on/off Active timeseries True
42 cnes cne CriticalNetworkElement ram txy MW Remaining available capacity True
43 cnes cne CriticalNetworkElement ptdf map_txy Power Transfer Distribution Factor True
44 dclines dcline DCLine #comment string User comment False
45 dclines dcline DCLine name string Object name True
46 dclines dcline DCLine metadata json User metadata False
47 dclines dcline DCLine forward_capacity txy Defines the capacity from area A to area B True
48 dclines dcline DCLine backward_capacity txy Defines the capacity from area B to area A True
49 dclines dcline DCLine loss_percentage double 0.00 Loss percentage False
50 dclines dcline DCLine forward_cost double 0.00 Forward cost False
51 dclines dcline DCLine backward_cost double 0.00 Backward cost False
52 dclines dcline DCLine from_area string From area False
53 dclines dcline DCLine to_area string To area False
54 dclines dcline DCLine id int 0 Internal ID False
55 aggregated_hydro_modules enmag AggregatedHydroModule #comment string User comment False
56 aggregated_hydro_modules enmag AggregatedHydroModule name string Object name True
57 aggregated_hydro_modules enmag AggregatedHydroModule metadata json User metadata False
58 aggregated_hydro_modules enmag AggregatedHydroModule area_name string Area name False
59 aggregated_hydro_modules enmag AggregatedHydroModule reservoir_energy double 0.00 Total reservoir energy. Unit: MWh. True
60 aggregated_hydro_modules enmag AggregatedHydroModule station_power double 0.00 Max station production. Unit: MW. True
61 aggregated_hydro_modules enmag AggregatedHydroModule regulated_power_inflow txy MW Regulated power inflow True
62 aggregated_hydro_modules enmag AggregatedHydroModule unregulated_power_inflow txy MW Unregulated power inflow True
63 aggregated_hydro_modules enmag AggregatedHydroModule upper_reservoir_limits txy_optional MWh Upper reservoir limits False
64 aggregated_hydro_modules enmag AggregatedHydroModule lower_reservoir_limits txy_optional MWh Lower reservoir limits False
65 aggregated_hydro_modules enmag AggregatedHydroModule upper_production_limits txy_optional MW Upper production limits False
66 aggregated_hydro_modules enmag AggregatedHydroModule lower_production_limits txy_optional MW Lower production limits False
67 aggregated_hydro_modules enmag AggregatedHydroModule start_reservoir_energy double MWh 0.00 Initial aggregated reservoir energy True
68 global_settings GlobalSettings #comment string User comment False
69 global_settings GlobalSettings name string Object name True
70 global_settings GlobalSettings metadata json User metadata False
71 global_settings GlobalSettings output_path string Output and runtime directory where LTM will read and write data True
72 global_settings GlobalSettings simulation_period txy EMPS/EOPS simulation period. Previously calc_water_value_flag. True
73 global_settings GlobalSettings water_value_period txy_optional Water value period False
74 global_settings GlobalSettings data_period txy_optional Data period False
75 global_settings GlobalSettings historical_period txy Historical period True
76 global_settings GlobalSettings forecast_period txy_optional Forecast period False
77 global_settings GlobalSettings intraweek_timesteps txy_optional Former 'simulation_price_period' / price segments False
78 global_settings GlobalSettings timesteps_per_week int_optional Automatic, sequential time steps / price segments False
79 global_settings GlobalSettings max_iterations int 40 Default max iterations for local area water value calculations (vansim) False
80 global_settings GlobalSettings precision double 0.00 Default precision requirement for water value calculations (max allowed deviation) False
81 global_settings GlobalSettings default_max_iterations_battery int_optional Default max iterations for battery areas False
82 global_settings GlobalSettings default_precision_battery double_optional Default precision for batteries False
83 global_settings GlobalSettings default_spill_cost double 0.01 Default spill cost. Usually non-zero, but very close to zero. False
84 global_settings GlobalSettings default_load_penalty double 3000.00 Default load penalty. Must be higher than the highest price in any other market step. False
85 global_settings GlobalSettings etha double 1.00 ETHA False
86 global_settings GlobalSettings generate_output_dir bool 1 Generate a runtime subfolder under output_path False
87 global_settings GlobalSettings delete_output_dir bool 1 Delete runtime directory after execution False
88 global_settings GlobalSettings ignore_stopwords bool 0 Continue execution even if there are possible errors in EMPS/EOPS logs False
89 global_settings GlobalSettings estimate_pq_curve_from_energy_equivalent bool 1 Estimate PQ-curves from energy equivalent if a reservoir has an energy equivalent != .0 and is not connected to a plant False
90 global_settings GlobalSettings allow_validation_failures bool 0 Ignore validation failures False
91 global_settings GlobalSettings calendar_mode calendar_mode Calendar mode False
92 global_settings GlobalSettings export_target export_target False
93 global_settings GlobalSettings export_directory_path string False
94 global_settings GlobalSettings export_settings export_settings False
95 global_settings GlobalSettings simulation_type simulation_type Parallel or serial simulation False
96 global_settings GlobalSettings model_type model_type EMPS or EOPS model False
97 global_settings GlobalSettings unknown_key_policy unknown_key_policy Policy for what to do with unexpected keys in the JSON model. Strict = all keys must be known, strict_ignore_underscore = ignore keys starting with underscore, ignore_all = all known and unknown keys are allowed. False
98 global_settings GlobalSettings historical_type historical_type Historical period calendar type False
99 global_settings GlobalSettings num_price_scenarios int 1 False
100 global_settings GlobalSettings ltm_license_file_path string_optional Path to LTM license file False
101 global_settings GlobalSettings interest_rate double_optional Global interest rate False
102 global_settings GlobalSettings fbmc bool_optional Flow-Based Market-Coupling False
103 global_settings GlobalSettings fbmc_period txy_optional FBMC active period False
104 global_settings GlobalSettings jao_data_source string JAO data source (file) with PTDF data False
105 global_settings GlobalSettings kronasjer string EUR Default currency unit False
106 global_settings GlobalSettings currency_unit string EUR Currency unit False
107 global_settings GlobalSettings currency_cent_unit string c Currency cent unit False
108 global_settings GlobalSettings energy_unit string MWh Energy unit False
109 global_settings GlobalSettings num_processes int 1 Number of paralell MPI processess False
110 global_settings GlobalSettings extra_environment dict_type Expert use only. Additional environment variables to set when executing LTM applications. False
111 hydraulic_couplings hydraulic_coupling HydraulicCoupling #comment string User comment False
112 hydraulic_couplings hydraulic_coupling HydraulicCoupling name string Object name True
113 hydraulic_couplings hydraulic_coupling HydraulicCoupling metadata json User metadata False
114 hydraulic_couplings hydraulic_coupling HydraulicCoupling area_name string Area name False
115 hydraulic_couplings hydraulic_coupling HydraulicCoupling gate_switch_frequency int_optional unit-less Gate/hatch switch frequency. 0-100. 0 and 100 = no limits, 50 = most limited. Numbers 0-49, 51-100 determines what side of the hatch/gate to prefer. False
116 hydraulic_couplings hydraulic_coupling HydraulicCoupling max_flow int_optional m3/sec Max flow through the coupling, note the unit is an integer False
117 hydraulic_couplings hydraulic_coupling HydraulicCoupling station_joined bool bool 0 Is connected to a plant/station. Readonly False
118 inflow_series inflow Inflow #comment string User comment False
119 inflow_series inflow Inflow name string Object name True
120 inflow_series inflow Inflow metadata json User metadata False
121 inflow_series inflow Inflow series txy m^3/s Inflow series True
122 inflow_series inflow Inflow forecast txy_optional m^3/s Optional forecast series False
123 inflow_series inflow Inflow forecast_period txy_optional Optional forecast period False
124 loads load Load #comment string User comment False
125 loads load Load name string Object name True
126 loads load Load metadata json User metadata False
127 loads load Load area_name string Area name False
128 loads load Load capacity txy MW Load capacity True
129 market_calibration_areas market_calibration_area MarketCalibrationArea #comment string User comment False
130 market_calibration_areas market_calibration_area MarketCalibrationArea name string Object name True
131 market_calibration_areas market_calibration_area MarketCalibrationArea metadata json User metadata False
132 market_steps market_step MarketStep #comment string User comment False
133 market_steps market_step MarketStep name string Object name True
134 market_steps market_step MarketStep metadata json User metadata False
135 market_steps market_step MarketStep area_name string Area name False
136 market_steps market_step MarketStep capacity txy Capacity time series True
137 market_steps market_step MarketStep capacity_vv txy_optional Capacity time series used for the water value calculation False
138 market_steps market_step MarketStep price txy_optional Price time series False
139 market_steps market_step MarketStep exogenous_price txy_optional Exogenous price time series False
140 market_steps market_step MarketStep price_series_coefficients price_series_coeff_type_optional Coefficients for price series False
141 market_steps market_step MarketStep secondary_price_series_name string Name of connected seconday price series False
142 market_steps market_step MarketStep load_name string If set, the market step is connected to a load with the given name False
143 plants plant Plant #comment string User comment False
144 plants plant Plant name string Object name True
145 plants plant Plant metadata json User metadata False
146 plants plant Plant area_name string Area name False
147 plants plant Plant ownership double % 100.00 Ownership of this module. In percent False
148 plants plant Plant average_energy_equivalent double kWh/m3 0.00 Average local energy equivalent. Important for spillage, bypass and pumping. True
149 plants plant Plant discharge_energy_equivalent txy kWh/m^3 Local discharge energy equivalent time series, given together with turbine PQ-curves. The time period must be aligned with pq_curves. If using a repeating PQ-curve, discharge energy equivalent must be within the same range. If unsure, use `W01` False
150 plants plant Plant pq_curves xyt Time + X=m^3/sec Y=MW PQ efficiency curves. Must be used with discharge energy equivalent. Timestamps must also be in the same period as discharge energy equivalent. False
151 plants plant Plant unregulated_inflow txy m^3/sec Unregulated inflow time series False
152 plants plant Plant unregulated_inflow_name string Inflow series name False
153 plants plant Plant average_unregulated_inflow double m^3/s 0.00 Average yearly unregulated inflow. True
154 plants plant Plant max_discharge_curve txylin m3/sec Max discharge curve False
155 plants plant Plant max_discharge_series_name string string Series name for max discharge series in historical.h5 False
156 plants plant Plant max_discharge_scale double factor 0.00 Scale factor of the input series. Only used for series from historical.h5 False
157 plants plant Plant min_discharge_curve txylin m3/sec Min discharge curve False
158 plants plant Plant min_discharge_series_name string string Min discharge series name in historical.h5 False
159 plants plant Plant min_discharge_scale double factor 0.00 Min discharge scaling factor. Only used for series from historical.h5 False
160 plants plant Plant min_bypass_curve txylin m3/sec Min bypass curve False
161 plants plant Plant min_bypass_series_name string string Min bypass series name in historical.h5 False
162 plants plant Plant min_bypass_scale double factor 0.00 Min bypass scaling factor. Only used for series from historical.h5 False
163 plants plant Plant gross_head_max_discharge xy m3/s - m Maximum discharge as function of gross head False
164 plants plant Plant max_bypass_curve txylin m3/sec Max bypass curve False
165 plants plant Plant max_bypass_series_name string string Max bypass series name in historical.h5 False
166 plants plant Plant max_bypass_scale double factor 0.00 Max bypass scaling factor. Only used for series from historical.h5 False
167 plants plant Plant unavailable_capacity txy MW Planned capacity outage for a plant (revision) False
168 plants plant Plant breakdown_unavailable_capacity txy MW Unforeseen downtimes capacity outage for a plant (havari) False
169 price_series_main price_series_main MainPriceSeries #comment string User comment False
170 price_series_main price_series_main MainPriceSeries name string Object name True
171 price_series_main price_series_main MainPriceSeries metadata json User metadata False
172 price_series_main price_series_main MainPriceSeries series txy Unknown Price series values True
173 price_series_main price_series_main MainPriceSeries probabilities double_vector_optional Option to customise probabilities of the price scenarios. Overrides default: price scenarios has equal probability. False
174 price_series_main price_series_main MainPriceSeries percentiles_for_water_values double_vector Customize percentiles for the price levels. Adds a price scenario dimension to water values. False
175 price_series_secondary price_series_secondary SecondaryPriceSeries #comment string User comment False
176 price_series_secondary price_series_secondary SecondaryPriceSeries name string Object name True
177 price_series_secondary price_series_secondary SecondaryPriceSeries metadata json User metadata False
178 price_series_secondary price_series_secondary SecondaryPriceSeries series txy Unknown Price series values1. Given as a flattened Txy of  1931_1, 1931_2, 1932_1, ... True
179 price_series_secondary price_series_secondary SecondaryPriceSeries probabilities double_vector_optional Option to customise probabilities of the price scenarios. Use to override the default where each price scenario receives equal probability. False
180 pumps pump Pump #comment string User comment False
181 pumps pump Pump name string Object name True
182 pumps pump Pump metadata json User metadata False
183 pumps pump Pump area_name string Area name False
184 pumps pump Pump ownership double % 0.00 Pump ownership share True
185 pumps pump Pump average_power double MW 0.00 Average pump power True
186 pumps pump Pump pump_capacity xy meter, m3/sec Pump capacity, pump height / flow True
187 pumps pump Pump upper_reservoir_reference_curve txylin timestamp, Mm3 Upper reservoir reference curve. Pump will stop pumping if upper reservoir goes over this limit. If not set, a default value of a full upper reservoir will be used. False
188 pumps pump Pump lower_reservoir_reference_curve txylin timestamp, Mm3 Lower reservoir reference curve. Pump will stop pumping if lower reservoir goes under this limit. If not set, a default value of an empty lower reservoir will be used. False
189 pumps pump Pump unavailable_capacity txy MW Planned capacity outage for a pump (revision) False
190 pumps pump Pump breakdown_unavailable_capacity txy MW Unforeseen downtimes capacity outage for a pump (havari) False
191 reservoirs reservoir Reservoir #comment string User comment False
192 reservoirs reservoir Reservoir name string Object name True
193 reservoirs reservoir Reservoir metadata json User metadata False
194 reservoirs reservoir Reservoir area_name string Area name False
195 reservoirs reservoir Reservoir module_number int 0 Automatically generated DETD module number. Used by LTM to build relations between modules. True
196 reservoirs reservoir Reservoir max_volume double Million m^3 0.00 Maximum volume of this reservoir False
197 reservoirs reservoir Reservoir degree_of_regulation double factor 0.00 Reservoir regulation capacity (reguleringsgrad) False
198 reservoirs reservoir Reservoir reservoir_type reservoir_type Regulation or buffer reservoir False
199 reservoirs reservoir Reservoir regulated_inflow txy m^3/sec Regulated inflow time series False
200 reservoirs reservoir Reservoir regulated_inflow_name string Inflow series name False
201 reservoirs reservoir Reservoir average_regulated_inflow double m^3/s 0.00 Average yearly regulated inflow. True
202 reservoirs reservoir Reservoir max_discharge double m^3/sec 0.00 Maximum production discharge True
203 reservoirs reservoir Reservoir reference_curve txylin Million m^3 Reservoir reference curve True
204 reservoirs reservoir Reservoir initial_volume double Mm3 0.00 Reservoir initial volume. False
205 reservoirs reservoir Reservoir max_volume_curve txylin Mm3 Restriction 1, reservoir max volume False
206 reservoirs reservoir Reservoir max_volume_curve_hard_limit int bool 0 Restriction 1, reservoir has max volume hard limit False
207 reservoirs reservoir Reservoir min_volume_curve txylin Mm3 Restriction 2, reservoir min volume False
208 reservoirs reservoir Reservoir min_volume_curve_hard_limit int bool 0 Restriction 2, reservoir has min volume hard limit False
209 reservoirs reservoir Reservoir max_discharge_curve txylin m3/sec Max discharge curve False
210 reservoirs reservoir Reservoir max_discharge_series_name string string Series name for max discharge series False
211 reservoirs reservoir Reservoir max_discharge_scale double factor 0.00 Scale factor of the input series False
212 reservoirs reservoir Reservoir min_discharge_curve txylin m3/sec Min discharge curve False
213 reservoirs reservoir Reservoir min_discharge_series_name string string Min discharge series name False
214 reservoirs reservoir Reservoir min_discharge_scale double factor 0.00 Min discharge scaling factor False
215 reservoirs reservoir Reservoir min_bypass_curve txylin m3/sec Min bypass curve False
216 reservoirs reservoir Reservoir min_bypass_series_name string string Min bypass series name False
217 reservoirs reservoir Reservoir min_bypass_scale double factor 0.00 Min bypass scaling factor False
218 reservoirs reservoir Reservoir max_bypass_curve txylin m3/sec Max bypass curve\n\nTime dependent curve for maximum allowed bypass False
219 reservoirs reservoir Reservoir max_bypass_series_name string string Max bypass series name False
220 reservoirs reservoir Reservoir max_bypass_scale double factor 0.00 Max bypass scaling factor False
221 reservoirs reservoir Reservoir volume_curve xy meter / Mm3 Reservoir volume curve False
222 reservoirs reservoir Reservoir gross_head double m 0.00 Nominal gross head/level (brutto fallhoyde) False
223 reservoirs reservoir Reservoir tailrace_elevation double m 0.00 Plant tailrace elevation (utlopskote stasjon) False
224 reservoirs reservoir Reservoir hc_max_flow int_optional Hydraulic coupling max flow\n\nOverride max_flow in a hydraulic system per module False
225 reservoirs reservoir Reservoir hc_has_gate int_optional Hydraulic coupling has gate\n\nOverride has_gate in a hydraulic system per module False
226 solar solar Solar #comment string User comment False
227 solar solar Solar name string Object name True
228 solar solar Solar metadata json User metadata False
229 solar solar Solar area_name string Area name False
230 solar solar Solar capacity txy MW Solar power True
231 spills spill Spill #comment string User comment False
232 spills spill Spill name string Object name True
233 spills spill Spill metadata json User metadata False
234 uncontrollable_generation uncontrollable_generation UncontrollableGeneration #comment string User comment False
235 uncontrollable_generation uncontrollable_generation UncontrollableGeneration name string Object name True
236 uncontrollable_generation uncontrollable_generation UncontrollableGeneration metadata json User metadata False
237 uncontrollable_generation uncontrollable_generation UncontrollableGeneration area_name string Area name False
238 uncontrollable_generation uncontrollable_generation UncontrollableGeneration series_name string Name of uncontrollable generation series True
239 uncontrollable_generation uncontrollable_generation UncontrollableGeneration scale txy Scaling factor for the uncontrollable generation series False
240 uncontrollable_generation_series uncontrollable_generation_series UncontrollableGenerationSeries #comment string User comment False
241 uncontrollable_generation_series uncontrollable_generation_series UncontrollableGenerationSeries name string Object name True
242 uncontrollable_generation_series uncontrollable_generation_series UncontrollableGenerationSeries metadata json User metadata False
243 uncontrollable_generation_series uncontrollable_generation_series UncontrollableGenerationSeries series txy Uncontrollable power generation series True
244 watercourses watercourse Watercourse #comment string User comment False
245 watercourses watercourse Watercourse name string Object name True
246 watercourses watercourse Watercourse metadata json User metadata False
247 watercourses watercourse Watercourse area_name string Area name False
248 wind wind Wind #comment string User comment False
249 wind wind Wind name string Object name True
250 wind wind Wind metadata json User metadata False
251 wind wind Wind area_name string Area name False
252 wind wind Wind capacity txy MW Wind power True