Simulation with Dynawo

The dynamic module allows to run time domain simulation.

ModelMapping

ModelMapping()	class to map elements of a network to their respective dynamic behavior
ModelMapping.get_categories_names()	Get the dynamic model categories
ModelMapping.get_categories_information()	Get more informations about categories
ModelMapping.get_supported_models([...])	Get the supported dynamic models for a given category or for all categories if no category_name is given
ModelMapping.get_supported_models_information([...])	Get more informations about the supported dynamic models for a given category or for all categories if no category_name is given
ModelMapping.add_dynamic_model(category_name)	Add a dynamic model from category_name
ModelMapping.add_base_load([df])	Add a load mapping
ModelMapping.add_load_one_transformer([df])	Add a load with one transformer mapping
ModelMapping.add_load_one_transformer_tap_changer([df])	Add a load with one transformer and tap changer mapping
ModelMapping.add_load_two_transformers([df])	Add a load with two transformers mapping
ModelMapping.add_load_two_transformers_tap_changers([df])	Add a load with two transformers and tap changers mapping
ModelMapping.add_base_generator([df])	Add a base generator mapping
ModelMapping.add_synchronized_generator([df])	Add a synchronized generator mapping
ModelMapping.add_synchronous_generator([df])	Add a synchronous generator mapping
ModelMapping.add_signal_n_generator([df])	Add a signal N generator mapping
ModelMapping.add_wecc([df])	Add a WECC mapping
ModelMapping.add_grid_forming_converter([df])	Add a grid forming converter mapping
ModelMapping.add_inertial_grid([df])	Add an inertial grid mapping
ModelMapping.add_hvdc_p([df])	Add an HVDC P mapping
ModelMapping.add_hvdc_vsc([df])	Add an HVDC VSC mapping
ModelMapping.add_base_transformer([df])	Add a transformer mapping
ModelMapping.add_base_static_var_compensator([df])	Add a static var compensator mapping
ModelMapping.add_shunt([df])	Add a shunt compensator mapping
ModelMapping.add_base_line([df])	Add a line mapping
ModelMapping.add_base_bus([df])	Add a base bus mapping
ModelMapping.add_infinite_bus([df])	Add an infinite bus mapping
ModelMapping.add_overload_management_system([df])	Add a dynamic overload management system (not link to a network element)
ModelMapping.add_two_level_overload_management_system([df])	Add a dynamic two level overload management system (not link to a network element)
ModelMapping.add_under_voltage_automation_system([df])	Add a dynamic under voltage automation system (not link to a network element)
ModelMapping.add_phase_shifter_i_automation_system([df])	Add a dynamic phase shifter I automation system (not link to a network element)
ModelMapping.add_phase_shifter_p_automation_system([df])	Add a dynamic phase shifter P automation system (not link to a network element)
ModelMapping.add_phase_shifter_blocking_i_automation_system([df])	Add a dynamic phase shifter blocking I automation system (not link to a network element)
ModelMapping.add_tap_changer_automation_system([df])	Add a dynamic tap changer automation system (not link to a network element)
ModelMapping.add_tap_changer_blocking_automation_system(df, ...)	Add a dynamic tap changer blocking automation system (not link to a network element)

EventMapping

EventMapping()	Class to map events
EventMapping.get_events_information()	Get more informations about events
EventMapping.add_disconnection([df])	Creates an equipment disconnection event
EventMapping.add_active_power_variation([df])	Creates an active power variation event on generator or load
EventMapping.add_reactive_power_variation([df])	Creates a reactive power variation event on load and generator without dynamic model
EventMapping.add_reference_voltage_variation([df])	Creates a reference voltage variation event on synchronized and synchronous generator
EventMapping.add_node_fault([df])	Creates a bus node fault event
EventMapping.add_event_model(event_name[, df])	Add an event model with event_name

OutputVariableMapping

OutputVariableMapping()	Class to map Curves and Final State Values
OutputVariableMapping.add_curves(model_id, ...)	Adds curves on a single dynamic model or network equipment without dynamic model
OutputVariableMapping.add_final_state_values(...)	Adds final state values on a single dynamic model or network equipment without dynamic model
OutputVariableMapping.add_dynamic_model_curves(...)
OutputVariableMapping.add_standard_model_curves(...)
OutputVariableMapping.add_dynamic_model_final_state_values(...)
OutputVariableMapping.add_standard_model_final_state_values(...)

Parameters

Parameters([start_time, stop_time, ...])	Parameters for a dynamic simulation execution.
Simulation.get_provider_parameters()	Supported dynamic simulation specific parameters for a given provider.
Simulation.get_provider_parameters_names()	Get list of parameters for Dynawo provider.

Simulation

Simulation()
Simulation.run(network, model_mapping[, ...])	Run the dynawo simulation

Results

SimulationResult(handle)	Can only be instantiated by run()
SimulationResult.status()	Status of the simulation (SUCCESS or FAILURE)
SimulationResult.status_text()	Status text of the simulation (failure description or empty if success)
SimulationResult.curves()	Dataframe of the curves results, columns are the curves names and rows are timestep
SimulationResult.final_state_values()	Dataframe of the final state values results, first column is the fsv names, second one the final state values
SimulationResult.timeline()	Dataframe of the simulation timeline, first column is the event time, second one the model name and the third one the event message