Brief introduction to stepspy APIs

This page lists all available APIs in stepspy. You can run the following codes from folder /python in STEPS source file to generate the markdown version:

python extract_stepspy_apis.py
python convert_stepspy_apis_to_markdown.py
python convert_stepspy_apis_to_markdown_glance.py

Click the following links to check API details.

Toolkit related APIs

1. set_encode
2. get_encode
3. set_toolkit_log_file
4. set_parallel_thread_number
5. get_parallel_thread_number
6. clear_toolkit
7. get_toolkit_float_data
8. set_toolkit_float_data
9. get_toolkit_string_data
10. set_toolkit_string_data
11. get_toolkit_bool_data
12. set_toolkit_bool_data
13. get_system_base_power_in_MVA
14. set_system_base_power_in_MVA
15. get_case_information
16. get_case_additional_information
17. set_case_information
18. set_case_additional_information
19. get_toolkit_detailed_log_logic
20. set_toolkit_detailed_log_logic

Capacity related APIs

21. get_allowed_maximum_bus_number
22. set_allowed_maximum_bus_number
23. get_bus_capacity
24. get_generator_capacity
25. get_wt_generator_capacity
26. get_pv_unit_capacity
27. get_load_capacity
28. get_fixed_shunt_capacity
29. get_line_capacity
30. get_transformer_capacity
31. get_hvdc_capacity
32. get_equivalent_device_capacity
33. get_energy_storage_capacity
34. get_area_capacity
35. get_zone_capacity
36. get_owner_capacity
37. set_bus_capacity
38. set_generator_capacity
39. set_wt_generator_capacity
40. set_pv_unit_capacity
41. set_load_capacity
42. set_fixed_shunt_capacity
43. set_line_capacity
44. set_transformer_capacity
45. set_hvdc_capacity
46. set_equivalent_device_capacity
47. set_energy_storage_capacity
48. set_area_capacity
49. set_zone_capacity
50. set_owner_capacity
51. get_dynamic_model_database_capacity
52. set_dynamic_model_database_capacity

Device manipulation related APIs

53. add_bus
54. add_generator
55. add_wt_generator
56. add_pv_unit
57. add_load
58. add_fixed_shunt
59. add_line
60. add_hvdc
61. add_transformer
62. add_equivalent_device
63. add_energy_storage
64. add_area
65. add_zone
66. add_owner
67. remove_bus
68. remove_generator
69. remove_wt_generator
70. remove_pv_unit
71. remove_load
72. remove_fixed_shunt
73. remove_line
74. remove_hvdc
75. remove_transformer
76. remove_equivalent_device
77. remove_energy_storage
78. remove_area
79. remove_zone
80. remove_owner
81. change_bus_number
82. change_bus_number_with_file

Device count related APIs

83. get_bus_count
84. get_generator_count
85. get_wt_generator_count
86. get_pv_unit_count
87. get_load_count
88. get_fixed_shunt_count
89. get_line_count
90. get_transformer_count
91. get_hvdc_count
92. get_equivalent_device_count
93. get_energy_storage_count
94. get_area_count
95. get_zone_count
96. get_owner_count
97. get_in_service_bus_count
98. update_overshadowed_buses
99. set_all_buses_un_overshadowed
100. get_overshadowed_bus_count

Device existance related APIs

101. is_bus_exist
102. is_generator_exist
103. is_wt_generator_exist
104. is_pv_unit_exist
105. is_load_exist
106. is_fixed_shunt_exist
107. is_line_exist
108. is_transformer_exist
109. is_hvdc_exist
110. is_equivalent_device_exist
111. is_energy_storage_exist

Name2number conversion related APIs

112. bus_name2number
113. bus_number2name

Device retrieving related APIs

114. get_all_buses
115. get_buses_with_constraints
116. get_all_generators
117. get_generators_at_bus
118. get_all_wt_generators
119. get_wt_generators_at_bus
120. get_all_pv_units
121. get_pv_units_at_bus
122. get_all_energy_storages
123. get_energy_storages_at_bus
124. get_all_loads
125. get_loads_at_bus
126. get_all_fixed_shunts
127. get_fixed_shunts_at_bus
128. get_all_equivalent_devices
129. get_equivalent_devices_at_bus
130. get_all_lines
131. get_lines_at_bus
132. get_lines_between_buses
133. get_all_transformers
134. get_transformers_at_bus
135. get_transformers_between_buses
136. get_all_hvdcs
137. get_hvdcs_at_bus
138. get_hvdcs_between_buses
139. get_generators_with_constraints
140. get_wt_generators_with_constraints
141. get_pv_units_with_constraints
142. get_loads_with_constraints
143. get_all_areas
144. get_all_zones
145. get_all_owners

Device data manipulation related APIs

146. get_bus_data
147. get_generator_data
148. get_wt_generator_data
149. get_pv_unit_data
150. get_energy_storage_data
151. get_load_data
152. get_fixed_shunt_data
153. get_equivalent_device_data
154. get_line_data
155. get_transformer_data
156. get_hvdc_data
157. get_area_data
158. get_zone_data
159. get_owner_data
160. set_bus_data
161. set_generator_data
162. set_wt_generator_data
163. set_pv_unit_data
164. set_energy_storage_data
165. set_generator_power
166. set_wt_generator_power
167. set_pv_unit_power
168. set_energy_storage_power
169. set_load_data
170. set_load_power
171. set_fixed_shunt_data
172. set_equivalent_device_data
173. set_line_data
174. set_transformer_data
175. set_hvdc_data
176. set_hvdc_power
177. set_area_data
178. set_zone_data
179. set_owner_data

Powerflow related APIs

180. load_powerflow_data
181. check_powerflow_data
182. save_powerflow_data
183. load_powerflow_result
184. get_powerflow_solver_parameter
185. set_powerflow_solver_parameter
186. show_powerflow_solver_configuration
187. solve_powerflow
188. is_powerflow_converged
189. get_powerflow_loss
190. show_powerflow_result
191. save_powerflow_result
192. save_extended_powerflow_result
193. save_jacobian_matrix

Network related APIs

194. build_network_Y_matrix
195. build_decoupled_network_B_matrix
196. build_dc_network_B_matrix
197. build_dynamic_network_Y_matrix
198. build_network_Z_matrix
199. save_network_Y_matrix
200. save_decoupled_network_B_matrix
201. save_dc_network_B_matrix
202. save_dynamic_network_Y_matrix
203. save_network_Z_matrix
204. check_network_connectivity

Dynamic model related APIs

205. load_dynamic_data
206. save_dynamic_data
207. check_dynamic_data
208. check_missing_models
209. check_least_dynamic_time_constants
210. converte_hvdc_to_load
211. set_dynamic_model
212. disable_generator_related_model
213. enable_generator_related_model
214. get_generator_related_model_name
215. get_generator_related_model_data
216. set_generator_related_model_data
217. get_generator_related_model_parameter_pair
218. get_wt_generator_related_model_name
219. get_wt_generator_related_model_data
220. set_wt_generator_related_model_data
221. get_wt_generator_related_model_parameter_pair
222. get_pv_unit_related_model_name
223. get_pv_unit_related_model_data
224. set_pv_unit_related_model_data
225. get_pv_unit_related_model_parameter_pair
226. get_load_related_model_name
227. get_load_related_model_data
228. set_load_related_model_data
229. get_load_related_model_parameter_pair
230. get_line_related_model_name
231. get_line_related_model_data
232. set_line_related_model_data
233. get_line_related_model_parameter_pair
234. get_hvdc_related_model_name
235. get_hvdc_related_model_data
236. set_hvdc_related_model_data
237. get_hvdc_related_model_parameter_pair
238. get_generator_governor_pmax
239. get_generator_governor_pmin
240. get_generator_governor_up_spinning_reserve
241. get_generator_governor_down_spinning_reserve
242. get_generator_governor_total_up_spinning_reserve_with_constraints
243. get_generator_governor_total_down_spinning_reserve_with_constraints
244. get_generator_governor_total_pmax_with_constraints
245. get_generator_governor_total_pmin_with_constraints

Dynamic simulation related APIs

246. get_dynamic_simulator_parameter
247. set_dynamic_simulator_parameter
248. get_dynamic_simulator_output_file
249. set_dynamic_simulator_output_file
250. get_dynamic_simulation_time_step
251. set_dynamic_simulation_time_step
252. show_dynamic_simulation_configuration
253. get_dynamic_simulation_time
254. clear_meters
255. prepare_meters
256. prepare_bus_meter
257. prepare_generator_meter
258. prepare_wt_generator_meter
259. prepare_pv_unit_meter
260. prepare_energy_storage_meter
261. prepare_load_meter
262. prepare_line_meter
263. prepare_transformer_meter
264. prepare_hvdc_meter
265. prepare_equivalent_device_meter
266. start_dynamic_simulation
267. stop_dynamic_simulation
268. run_dynamic_simulation_to_time
269. run_a_step
270. is_system_angular_stable
271. get_user_meter_value
272. get_basic_meter_value
273. set_bus_fault
274. clear_bus_fault
275. trip_bus
276. set_line_fault
277. clear_line_fault
278. trip_line
279. trip_line_breaker
280. close_line
281. close_line_breaker
282. trip_transformer
283. trip_transformer_breaker
284. close_transformer
285. close_transformer_breaker
286. trip_generator
287. shed_generator
288. trip_wt_generator
289. shed_wt_generator
290. trip_load
291. close_load
292. scale_load
293. scale_all_loads
294. trip_fixed_shunt
295. close_fixed_shunt
296. manually_bypass_hvdc
297. manually_block_hvdc
298. manually_unbypass_hvdc
299. manually_unblock_hvdc
300. get_generator_voltage_reference_in_pu
301. get_generator_mechanical_power_reference_in_pu
302. get_generator_mechanical_power_reference_in_MW
303. set_generator_voltage_reference_in_pu
304. set_generator_mechanical_power_reference_in_pu
305. set_generator_mechanical_power_reference_in_MW
306. get_generator_excitation_voltage_in_pu
307. get_generator_mechanical_power_in_pu
308. get_generator_mechanical_power_in_MW
309. set_generator_excitation_voltage_in_pu
310. set_generator_mechanical_power_in_pu
311. set_generator_mechanical_power_in_MW
312. get_hvdc_power_order_in_MW
313. set_hvdc_power_order_in_MW