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.27.1'
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 busbars busbar Busbar busbar_id int 0 Busbar identifier. True
30 busbars busbar Busbar name string Busbar name. False
31 busbars busbar Busbar #comment string Busbar comment. False
32 busbars busbar Busbar area_name string Area name. False
33 busbars busbar Busbar load_weight double 0.00 Load weight. The load allocated to the busbar. True
34 busbars busbar Busbar hydro_plant_weights map_double Hydro plant weight. The hydro plant production allocated to the busbar. True
35 busbars busbar Busbar market_step_weights map_double Market step weight. The market step generation/load allocated to the busbar. True
36 busbars busbar Busbar wind_park_weights map_double Wind park weights. The wind/solar/uncontrollable generation allocated to the busbar. True
37 bypasses bypass Bypass #comment string User comment False
38 bypasses bypass Bypass name string Object name True
39 bypasses bypass Bypass metadata json User metadata False
40 bypasses bypass Bypass min_bypass_curve txylin m3/sec Min bypass curve False
41 bypasses bypass Bypass min_bypass_series_name string string Min bypass series name False
42 bypasses bypass Bypass min_bypass_scale double factor 0.00 Min bypass scaling factor False
43 bypasses bypass Bypass max_bypass_curve txylin m3/sec Max bypass curve False
44 bypasses bypass Bypass max_bypass_series_name string string Max bypass series name False
45 bypasses bypass Bypass max_bypass_scale double factor 0.00 Max bypass scaling factor False
46 cnes cne CriticalNetworkElement #comment string User comment False
47 cnes cne CriticalNetworkElement name string Object name True
48 cnes cne CriticalNetworkElement metadata json User metadata False
49 cnes cne CriticalNetworkElement active txy time/on/off Active timeseries True
50 cnes cne CriticalNetworkElement ram txy MW Remaining available capacity True
51 cnes cne CriticalNetworkElement ptdf map_txy Power Transfer Distribution Factor True
52 dclines dcline DCLine #comment string User comment False
53 dclines dcline DCLine name string Object name True
54 dclines dcline DCLine metadata json User metadata False
55 dclines dcline DCLine forward_capacity txy Defines the capacity from area A to area B True
56 dclines dcline DCLine backward_capacity txy Defines the capacity from area B to area A True
57 dclines dcline DCLine loss_percentage double 0.00 Loss percentage False
58 dclines dcline DCLine forward_cost double 0.00 Forward cost False
59 dclines dcline DCLine backward_cost double 0.00 Backward cost False
60 dclines dcline DCLine from_area string From area False
61 dclines dcline DCLine to_area string To area False
62 dclines dcline DCLine id int 0 Internal ID False
63 aggregated_hydro_modules enmag AggregatedHydroModule #comment string User comment False
64 aggregated_hydro_modules enmag AggregatedHydroModule name string Object name True
65 aggregated_hydro_modules enmag AggregatedHydroModule metadata json User metadata False
66 aggregated_hydro_modules enmag AggregatedHydroModule area_name string Area name False
67 aggregated_hydro_modules enmag AggregatedHydroModule reservoir_energy double 0.00 Total reservoir energy. Unit: MWh. True
68 aggregated_hydro_modules enmag AggregatedHydroModule station_power double 0.00 Max station production. Unit: MW. True
69 aggregated_hydro_modules enmag AggregatedHydroModule regulated_power_inflow txy MW Regulated power inflow True
70 aggregated_hydro_modules enmag AggregatedHydroModule unregulated_power_inflow txy MW Unregulated power inflow True
71 aggregated_hydro_modules enmag AggregatedHydroModule upper_reservoir_limits txy_optional MWh Upper reservoir limits False
72 aggregated_hydro_modules enmag AggregatedHydroModule lower_reservoir_limits txy_optional MWh Lower reservoir limits False
73 aggregated_hydro_modules enmag AggregatedHydroModule upper_production_limits txy_optional MW Upper production limits False
74 aggregated_hydro_modules enmag AggregatedHydroModule lower_production_limits txy_optional MW Lower production limits False
75 aggregated_hydro_modules enmag AggregatedHydroModule start_reservoir_energy double MWh 0.00 Initial aggregated reservoir energy True
76 global_settings GlobalSettings #comment string User comment False
77 global_settings GlobalSettings name string Object name True
78 global_settings GlobalSettings metadata json User metadata False
79 global_settings GlobalSettings output_path string Output and runtime directory where LTM will read and write data True
80 global_settings GlobalSettings output_path_suffix string Optional suffix for output directory False
81 global_settings GlobalSettings simulation_period txy EMPS/EOPS simulation period. Previously calc_water_value_flag. True
82 global_settings GlobalSettings water_value_period txy_optional Water value period False
83 global_settings GlobalSettings data_period txy_optional Data period False
84 global_settings GlobalSettings historical_period txy Historical period True
85 global_settings GlobalSettings forecast_period txy_optional Forecast period False
86 global_settings GlobalSettings intraweek_timesteps txy_optional Former 'simulation_price_period' / price segments False
87 global_settings GlobalSettings timesteps_per_week int_optional Automatic, sequential time steps / price segments False
88 global_settings GlobalSettings max_iterations int 40 Default max iterations for local area water value calculations (vansim) False
89 global_settings GlobalSettings precision double 0.00 Default precision requirement for water value calculations (max allowed deviation) False
90 global_settings GlobalSettings default_max_iterations_battery int_optional Default max iterations for battery areas False
91 global_settings GlobalSettings default_precision_battery double_optional Default precision for batteries False
92 global_settings GlobalSettings default_spill_cost double 0.01 Default spill cost. Usually non-zero, but very close to zero. False
93 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
94 global_settings GlobalSettings etha double 1.00 ETHA False
95 global_settings GlobalSettings generate_output_dir bool 1 Generate a runtime subfolder under output_path False
96 global_settings GlobalSettings delete_output_dir bool 1 Delete runtime directory after execution False
97 global_settings GlobalSettings ignore_stopwords bool 0 Continue execution even if there are possible errors in EMPS/EOPS logs False
98 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
99 global_settings GlobalSettings allow_validation_failures bool 0 Ignore validation failures False
100 global_settings GlobalSettings calendar_mode calendar_mode Calendar mode False
101 global_settings GlobalSettings export_target export_target False
102 global_settings GlobalSettings export_directory_path string False
103 global_settings GlobalSettings export_settings export_settings False
104 global_settings GlobalSettings simulation_type simulation_type Parallel or serial simulation False
105 global_settings GlobalSettings model_type model_type EMPS or EOPS model False
106 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
107 global_settings GlobalSettings historical_type historical_type Historical period calendar type False
108 global_settings GlobalSettings ltm_license_file_path string_optional Path to LTM license file False
109 global_settings GlobalSettings interest_rate double_optional Global interest rate False
110 global_settings GlobalSettings fbmc bool_optional Flow-Based Market-Coupling False
111 global_settings GlobalSettings fbmc_period txy_optional FBMC active period False
112 global_settings GlobalSettings jao_data_source string JAO data source (file) with PTDF data False
113 global_settings GlobalSettings kronasjer string EUR Default currency unit False
114 global_settings GlobalSettings currency_unit string EUR Currency unit False
115 global_settings GlobalSettings currency_cent_unit string c Currency cent unit False
116 global_settings GlobalSettings energy_unit string MWh Energy unit False
117 global_settings GlobalSettings num_processes int 1 Number of paralell MPI processess False
118 global_settings GlobalSettings extra_environment dict_type Expert use only. Additional environment variables to set when executing LTM applications. False
119 global_settings GlobalSettings ignore_detailed_grid bool 0 Run simulation without detailed grid. Physical flow is replaced by economic flow on aggregated interconnections. False
120 global_settings GlobalSettings samnett_grid_validation bool 0 Validate the detailed grid without running a simulation (samnett validation from wlog). default is false False
121 hvdc_connections hvdc_connection HvdcConnection #comment string User comment False
122 hvdc_connections hvdc_connection HvdcConnection name string Object name True
123 hvdc_connections hvdc_connection HvdcConnection metadata json User metadata False
124 hvdc_connections hvdc_connection HvdcConnection name_of_dcline string Converts DCLine-objects to HVDC lines by reference to DCline name True
125 hvdc_connections hvdc_connection HvdcConnection from_busbar_id int 0 Busbar from False
126 hvdc_connections hvdc_connection HvdcConnection to_busbar_id int 0 Busbar to False
127 hydraulic_couplings hydraulic_coupling HydraulicCoupling #comment string User comment False
128 hydraulic_couplings hydraulic_coupling HydraulicCoupling name string Object name True
129 hydraulic_couplings hydraulic_coupling HydraulicCoupling metadata json User metadata False
130 hydraulic_couplings hydraulic_coupling HydraulicCoupling area_name string Area name False
131 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
132 hydraulic_couplings hydraulic_coupling HydraulicCoupling max_flow int_optional m3/sec Max flow through the coupling, note the unit is an integer False
133 hydraulic_couplings hydraulic_coupling HydraulicCoupling station_joined bool bool 0 Is connected to a plant/station. Readonly False
134 inflow_series inflow Inflow #comment string User comment False
135 inflow_series inflow Inflow name string Object name True
136 inflow_series inflow Inflow metadata json User metadata False
137 inflow_series inflow Inflow series txy m^3/s Inflow series True
138 inflow_series inflow Inflow forecast txy_optional m^3/s Optional forecast series False
139 inflow_series inflow Inflow forecast_period txy_optional Optional forecast period False
140 lines line Line #comment string User comment False
141 lines line Line name string Object name True
142 lines line Line metadata json User metadata False
143 lines line Line from_busbar_id int 0 Defines coupling point and direction for Line 'from busbar' True
144 lines line Line to_busbar_id int 0 Defines coupling point and direction for Line 'to busbar' True
145 lines line Line resistance double Ohm 0.00 Resistance True
146 lines line Line reactance double Ohm 0.00 Reactance True
147 lines line Line base_voltage double kV 0.00 Base Voltage True
148 lineoutages lineoutage LineOutage #comment string User comment False
149 lineoutages lineoutage LineOutage name string Object name True
150 lineoutages lineoutage LineOutage metadata json User metadata False
151 lineoutages lineoutage LineOutage from_busbar_id int 0 Defines coupling point and direction for Line 'from busbar' True
152 lineoutages lineoutage LineOutage to_busbar_id int 0 Defines coupling point and direction for Line 'to busbar' True
153 lineoutages lineoutage LineOutage outage_forward txy MW Txy datatype. Defines period with reduced line capacity in forward direction True
154 lineoutages lineoutage LineOutage outage_backward txy MW Txy datatype. Defines period with reduced line capacity in backward direction True
155 loads load Load #comment string User comment False
156 loads load Load name string Object name True
157 loads load Load metadata json User metadata False
158 loads load Load area_name string Area name False
159 loads load Load capacity txy MW Load capacity True
160 market_calibration_areas market_calibration_area MarketCalibrationArea #comment string User comment False
161 market_calibration_areas market_calibration_area MarketCalibrationArea name string Object name True
162 market_calibration_areas market_calibration_area MarketCalibrationArea metadata json User metadata False
163 market_steps market_step MarketStep #comment string User comment False
164 market_steps market_step MarketStep name string Object name True
165 market_steps market_step MarketStep metadata json User metadata False
166 market_steps market_step MarketStep area_name string Area name False
167 market_steps market_step MarketStep capacity txy Capacity time series True
168 market_steps market_step MarketStep capacity_vv txy_optional Capacity time series used for the water value calculation False
169 market_steps market_step MarketStep price txy_optional Price time series False
170 market_steps market_step MarketStep exogenous_price txy_optional Exogenous price time series False
171 market_steps market_step MarketStep price_series_coefficients price_series_coeff_type_optional Coefficients for price series False
172 market_steps market_step MarketStep secondary_price_series_name string Name of connected seconday price series False
173 market_steps market_step MarketStep load_name string If set, the market step is connected to a load with the given name False
174 monitored_network_elements monitored_network_element MonitoredNetworkElement #comment string User comment False
175 monitored_network_elements monitored_network_element MonitoredNetworkElement name string Object name True
176 monitored_network_elements monitored_network_element MonitoredNetworkElement metadata json User metadata False
177 monitored_network_elements monitored_network_element MonitoredNetworkElement from_area string From area name True
178 monitored_network_elements monitored_network_element MonitoredNetworkElement to_area string To area name True
179 monitored_network_elements monitored_network_element MonitoredNetworkElement forward_capacity txy MW Forward capacity for specified period of monitored elements True
180 monitored_network_elements monitored_network_element MonitoredNetworkElement backward_capacity txy MW Backward capacity for specified period of monitored elements True
181 monitored_network_elements monitored_network_element MonitoredNetworkElement monitored_components component Busbar connection points and flow share on components True
182 plants plant Plant #comment string User comment False
183 plants plant Plant name string Object name True
184 plants plant Plant metadata json User metadata False
185 plants plant Plant area_name string Area name False
186 plants plant Plant ownership double % 100.00 Ownership of this module. In percent False
187 plants plant Plant average_energy_equivalent double kWh/m3 0.00 Average local energy equivalent. Important for spillage, bypass and pumping. True
188 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
189 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
190 plants plant Plant unregulated_inflow txy m^3/sec Unregulated inflow time series False
191 plants plant Plant unregulated_inflow_name string Inflow series name False
192 plants plant Plant average_unregulated_inflow double m^3/s 0.00 Average yearly unregulated inflow. True
193 plants plant Plant max_discharge_curve txylin m3/sec Max discharge curve False
194 plants plant Plant max_discharge_series_name string string Series name for max discharge series in historical.h5 False
195 plants plant Plant max_discharge_scale double factor 0.00 Scale factor of the input series. Only used for series from historical.h5 False
196 plants plant Plant min_discharge_curve txylin m3/sec Min discharge curve False
197 plants plant Plant min_discharge_series_name string string Min discharge series name in historical.h5 False
198 plants plant Plant min_discharge_scale double factor 0.00 Min discharge scaling factor. Only used for series from historical.h5 False
199 plants plant Plant min_bypass_curve txylin m3/sec Min bypass curve False
200 plants plant Plant min_bypass_series_name string string Min bypass series name in historical.h5 False
201 plants plant Plant min_bypass_scale double factor 0.00 Min bypass scaling factor. Only used for series from historical.h5 False
202 plants plant Plant gross_head_max_discharge xy m3/s - m Maximum discharge as function of gross head False
203 plants plant Plant max_bypass_curve txylin m3/sec Max bypass curve False
204 plants plant Plant max_bypass_series_name string string Max bypass series name in historical.h5 False
205 plants plant Plant max_bypass_scale double factor 0.00 Max bypass scaling factor. Only used for series from historical.h5 False
206 plants plant Plant unavailable_capacity txy MW Planned capacity outage for a plant (revision) False
207 plants plant Plant breakdown_unavailable_capacity txy MW Unforeseen downtimes capacity outage for a plant (havari) False
208 price_series_main price_series_main MainPriceSeries #comment string User comment False
209 price_series_main price_series_main MainPriceSeries name string Object name True
210 price_series_main price_series_main MainPriceSeries metadata json User metadata False
211 price_series_main price_series_main MainPriceSeries series txy Unknown Price series values True
212 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
213 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
214 price_series_secondary price_series_secondary SecondaryPriceSeries #comment string User comment False
215 price_series_secondary price_series_secondary SecondaryPriceSeries name string Object name True
216 price_series_secondary price_series_secondary SecondaryPriceSeries metadata json User metadata False
217 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
218 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
219 pumps pump Pump #comment string User comment False
220 pumps pump Pump name string Object name True
221 pumps pump Pump metadata json User metadata False
222 pumps pump Pump area_name string Area name False
223 pumps pump Pump ownership double % 0.00 Pump ownership share True
224 pumps pump Pump average_power double MW 0.00 Average pump power True
225 pumps pump Pump pump_capacity xy meter, m3/sec Pump capacity, pump height / flow True
226 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
227 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
228 pumps pump Pump unavailable_capacity txy MW Planned capacity outage for a pump (revision) False
229 pumps pump Pump breakdown_unavailable_capacity txy MW Unforeseen downtimes capacity outage for a pump (havari) False
230 reservoirs reservoir Reservoir #comment string User comment False
231 reservoirs reservoir Reservoir name string Object name True
232 reservoirs reservoir Reservoir metadata json User metadata False
233 reservoirs reservoir Reservoir area_name string Area name False
234 reservoirs reservoir Reservoir module_number int 0 Automatically generated DETD module number. Used by LTM to build relations between modules. True
235 reservoirs reservoir Reservoir max_volume double Million m^3 0.00 Maximum volume of this reservoir False
236 reservoirs reservoir Reservoir degree_of_regulation double factor 0.00 Reservoir regulation capacity (reguleringsgrad) False
237 reservoirs reservoir Reservoir reservoir_type reservoir_type Regulation or buffer reservoir False
238 reservoirs reservoir Reservoir regulated_inflow txy m^3/sec Regulated inflow time series False
239 reservoirs reservoir Reservoir regulated_inflow_name string Inflow series name False
240 reservoirs reservoir Reservoir average_regulated_inflow double m^3/s 0.00 Average yearly regulated inflow. True
241 reservoirs reservoir Reservoir max_discharge double m^3/sec 0.00 Maximum production discharge True
242 reservoirs reservoir Reservoir reference_curve txylin Million m^3 Reservoir reference curve True
243 reservoirs reservoir Reservoir initial_volume double Mm3 0.00 Reservoir initial volume. False
244 reservoirs reservoir Reservoir max_volume_curve txylin Mm3 Restriction 1, reservoir max volume False
245 reservoirs reservoir Reservoir max_volume_curve_hard_limit int bool 0 Restriction 1, reservoir has max volume hard limit False
246 reservoirs reservoir Reservoir min_volume_curve txylin Mm3 Restriction 2, reservoir min volume False
247 reservoirs reservoir Reservoir min_volume_curve_hard_limit int bool 0 Restriction 2, reservoir has min volume hard limit False
248 reservoirs reservoir Reservoir max_discharge_curve txylin m3/sec Max discharge curve False
249 reservoirs reservoir Reservoir max_discharge_series_name string string Series name for max discharge series False
250 reservoirs reservoir Reservoir max_discharge_scale double factor 0.00 Scale factor of the input series False
251 reservoirs reservoir Reservoir min_discharge_curve txylin m3/sec Min discharge curve False
252 reservoirs reservoir Reservoir min_discharge_series_name string string Min discharge series name False
253 reservoirs reservoir Reservoir min_discharge_scale double factor 0.00 Min discharge scaling factor False
254 reservoirs reservoir Reservoir min_bypass_curve txylin m3/sec Min bypass curve False
255 reservoirs reservoir Reservoir min_bypass_series_name string string Min bypass series name False
256 reservoirs reservoir Reservoir min_bypass_scale double factor 0.00 Min bypass scaling factor False
257 reservoirs reservoir Reservoir max_bypass_curve txylin m3/sec Max bypass curve\n\nTime dependent curve for maximum allowed bypass False
258 reservoirs reservoir Reservoir max_bypass_series_name string string Max bypass series name False
259 reservoirs reservoir Reservoir max_bypass_scale double factor 0.00 Max bypass scaling factor False
260 reservoirs reservoir Reservoir volume_curve xy meter / Mm3 Reservoir volume curve False
261 reservoirs reservoir Reservoir gross_head double m 0.00 Nominal gross head/level (brutto fallhoyde) False
262 reservoirs reservoir Reservoir tailrace_elevation double m 0.00 Plant tailrace elevation (utlopskote stasjon) False
263 reservoirs reservoir Reservoir hc_max_flow int_optional Hydraulic coupling max flow\n\nOverride max_flow in a hydraulic system per module False
264 reservoirs reservoir Reservoir hc_has_gate int_optional Hydraulic coupling has gate\n\nOverride has_gate in a hydraulic system per module False
265 run_config run_config RunConfig #comment string User comment False
266 run_config run_config RunConfig name string Object name True
267 run_config run_config RunConfig metadata json User metadata False
268 run_config run_config RunConfig no_swing_busbars int 1 Number of swing busbars in the ac-grid. Default is 1. True
269 run_config run_config RunConfig bus_number_swingbus_area_1 int 0 The busbar number of the first swingbus in the ac-grid. True
270 run_config run_config RunConfig filename_grid_description string nordel.dat Name of the file with the grid description. True
271 run_config run_config RunConfig include_shunt_elements bool 0 Include shunt elements in power flow calculations. False
272 run_config run_config RunConfig include_phase_shifter_in_loadflow_file bool 0 Include phase shifter in power flow calculations. False
273 run_config run_config RunConfig loss_calculation bool 1 Losses are computed in the DC load flow algorithm using an iterative algorithm. False
274 run_config run_config RunConfig marginal_loss_calculation bool 0 Marginal losses at all nodes are computed for all intraweek timesteps. Average weekly values are printed to the file 'MargLoss.dat'. False
275 run_config run_config RunConfig nordel_loss_functionality bool 0 Losses on interconnections are allocated the area receiving the transferred power. If NORDEL losses is set to .FALSE., the losses are divided equally between the connected areas. Default = false False
276 run_config run_config RunConfig print_fbmc_parameters bool 0 FBMC parameters are printed to file 'FBMCparams.csv' False
277 run_config run_config RunConfig successive_LP bool 0 If 'true' previously added power flow constraints are updated each time new PTDFs are computed. If 'false' power flow constraints are added iteratively without adjusting previously added constraints. Default = false False
278 run_config run_config RunConfig add_all_power_flow_constraints bool 0 'true': all power flow constraints are added to LP-problem. 'false': power flow constraints are added iteratively when overloads are found. False
279 run_config run_config RunConfig accepted_overload double 1.10 The accepted overload margin. If input is 1.10 (default), an overload exceeding the defined capacity limit (as defined in KOMBSNITT) by up to 10 percent is accepted when checking the base case flow. True
280 run_config run_config RunConfig relax_maske_bounds relax_maske_bounds Allows the user to keep the dcline forward and backward capacities bounds ('none' is default), remove bounds for overloaded interconnections ('partial') and fully remove bounds ('full'). False
281 run_config run_config RunConfig print_power_balance_mismatch_tolerance double 100.00 The accepted difference between the net area injection at transmission network level and at market model level. If difference is higher the mismatch is printed to the file 'BalanseSjekk.dat'. True
282 run_config run_config RunConfig ptdf_weight ptdf_weight Aggregation of PTDFs from transmission network level to area level. Options: 'flat' weighting, i.e., all busbars are weighted equally. 'injection' weighting based on power injections. 'sum_load_and_generation' provides weights based on the sum of the absolute values of load and generation. See docs. False
283 run_config run_config RunConfig max_grid_iterations int 15 Maximum number of iterations between the EMPS model (Area Optimization/Detailed Drawdown) and the DC power flow. The default value is 15. True
284 run_config run_config RunConfig loss_voltage_limit double kW 0.00 When low-voltage busbars are included convergence problems in the loss calculation may occur. Voltage level serving as a lower threshold for busbars included in the computation of losses. True
285 solar solar Solar #comment string User comment False
286 solar solar Solar name string Object name True
287 solar solar Solar metadata json User metadata False
288 solar solar Solar area_name string Area name False
289 solar solar Solar capacity txy MW Solar power True
290 solar solar Solar series_name string Solar power series name, reference to wind_data.h5 in the .ENMD-files. Auto-generated False
291 spills spill Spill #comment string User comment False
292 spills spill Spill name string Object name True
293 spills spill Spill metadata json User metadata False
294 two_winding_transformers two_winding_transformer TwoWindingTransformer #comment string User comment False
295 two_winding_transformers two_winding_transformer TwoWindingTransformer name string Object name True
296 two_winding_transformers two_winding_transformer TwoWindingTransformer metadata json User metadata False
297 two_winding_transformers two_winding_transformer TwoWindingTransformer from_busbar_id int 0 Defines coupling point and direction 'from busbar' True
298 two_winding_transformers two_winding_transformer TwoWindingTransformer to_busbar_id int 0 Defines coupling point and direction 'to busbar' True
299 two_winding_transformers two_winding_transformer TwoWindingTransformer short_circuit_voltage_real double % 0.00 Short circuit voltage real True
300 two_winding_transformers two_winding_transformer TwoWindingTransformer short_circuit_voltage_imaginary double % 0.00 Short circuit voltage imaginary True
301 two_winding_transformers two_winding_transformer TwoWindingTransformer rated_power double MVA 0.00 Rated power True
302 two_winding_transformers two_winding_transformer TwoWindingTransformer rated_voltage_regulating double kV 0.00 Rated voltage regulating True
303 two_winding_transformers two_winding_transformer TwoWindingTransformer rated_voltage_firm double kV 0.00 Rated voltage firm True
304 two_winding_transformers two_winding_transformer TwoWindingTransformer base_voltage_regulating double kV 0.00 Base voltage regulating True
305 two_winding_transformers two_winding_transformer TwoWindingTransformer base_voltage_firm double kV 0.00 Base voltage firm True
306 uncontrollable_generation uncontrollable_generation UncontrollableGeneration #comment string User comment False
307 uncontrollable_generation uncontrollable_generation UncontrollableGeneration name string Object name True
308 uncontrollable_generation uncontrollable_generation UncontrollableGeneration metadata json User metadata False
309 uncontrollable_generation uncontrollable_generation UncontrollableGeneration area_name string Area name False
310 uncontrollable_generation uncontrollable_generation UncontrollableGeneration series_name string Name of uncontrollable generation series True
311 uncontrollable_generation uncontrollable_generation UncontrollableGeneration scale txy Scaling factor for the uncontrollable generation series False
312 uncontrollable_generation_series uncontrollable_generation_series UncontrollableGenerationSeries #comment string User comment False
313 uncontrollable_generation_series uncontrollable_generation_series UncontrollableGenerationSeries name string Object name True
314 uncontrollable_generation_series uncontrollable_generation_series UncontrollableGenerationSeries metadata json User metadata False
315 uncontrollable_generation_series uncontrollable_generation_series UncontrollableGenerationSeries series txy Uncontrollable power generation series True
316 watercourses watercourse Watercourse #comment string User comment False
317 watercourses watercourse Watercourse name string Object name True
318 watercourses watercourse Watercourse metadata json User metadata False
319 watercourses watercourse Watercourse area_name string Area name False
320 wind wind Wind #comment string User comment False
321 wind wind Wind name string Object name True
322 wind wind Wind metadata json User metadata False
323 wind wind Wind area_name string Area name False
324 wind wind Wind capacity txy MW Wind power True
325 wind wind Wind series_name string Wind power series name, reference to wind_data.h5 in the .ENMD-files. Auto-generated False