PyDSS.pyPostprocessor.PostprocessScripts package

Subpackages

• PyDSS.pyPostprocessor.PostprocessScripts.DERMSOptimizer_helper_modules package
  • Submodules
  • PyDSS.pyPostprocessor.PostprocessScripts.DERMSOptimizer_helper_modules.opt_funcs module
  • Module contents
• PyDSS.pyPostprocessor.PostprocessScripts.create_upgrades_library package
  • Submodules
  • PyDSS.pyPostprocessor.PostprocessScripts.create_upgrades_library.AutomatedThermalUpgrade_createequiplibraries module
  • Module contents

Submodules

PyDSS.pyPostprocessor.PostprocessScripts.AutomatedThermalUpgrade module

class PyDSS.pyPostprocessor.PostprocessScripts.AutomatedThermalUpgrade.AutomatedThermalUpgrade(project, scenario, inputs, dssInstance, dssSolver, dssObjects, dssObjectsByClass, simulationSettings, Logger)

Bases: PyDSS.pyPostprocessor.pyPostprocessAbstract.AbstractPostprocess

The class is used to determine thermal upgrades

REQUIRED_INPUT_FIELDS = ('line_loading_limit', 'dt_loading_limit', 'line_safety_margin', 'xfmr_safety_margin', 'nominal_voltage', 'max_iterations', 'create_upgrade_plots', 'tps_to_test', 'create_upgrades_library', 'upgrade_library_path')

check_voltage_violations_multi_tps(upper_limit, lower_limit, raise_exception=True)

correct_line_violations()

correct_node_coords()

correct_xfmr_violations()

create_edge_node_dicts()

create_op_plots()

create_result_comparison(upper_limit=None, lower_limit=None)

determine_available_line_upgrades()

determine_available_xfmr_upgrades()

determine_line_ldgs()

determine_xfmr_ldgs()

determine_xfmr_ldgs_alltps()

determine_xfmr_ldgs_alltps_individual_object()

export_line_DT_parameters()

finalize()

Method used to combine post processing results from all steps.

generate_edges()

All lines, switches, reclosers etc are modeled as lines, so calling lines takes care of all of them. However we also need to loop over transformers as they form the edge between primary and secondary nodes :return:

generate_nodes()

get_line_info()

get_load_mults()

get_load_pv_mults_individual_object()

get_min_max_load_mult()

get_nodal_violations()

get_nodal_violations_individual_object()

linecode_lib_reformat()

plot_feeder()

read_available_upgrades(file)

read_load_files(dss_path)

read_load_files_get_load_pv_mults_individual_object(key_paths, dss_path)

read_pv_files_get_load_pv_mults_individual_object(key_paths, dss_path)

run(step, stepMax, simulation=None)

Method used to run a post processing script.

Parameters

• step (int) – Current step

• stepMax (int) – Last step of the simulation

• simulation (OpenDSS) – PyDSS simulation control class. Provided for access to control algorithms. Subclasses should not hold references to this instance after this method exits.

solve_diff_tps_lines()

solve_diff_tps_lines_individual_object()

time_limit_exception(expire_time, exception_message='Time limit exceeded')

write_dat_file(output_path=None)

write_dss_file(device_command)

write_to_json(dict, file_name)

PyDSS.pyPostprocessor.PostprocessScripts.AutomatedThermalUpgrade.get_transformer_info()

PyDSS.pyPostprocessor.PostprocessScripts.AutomatedThermalUpgrade_helper module

class PyDSS.pyPostprocessor.PostprocessScripts.AutomatedThermalUpgrade_helper.AutomatedThermalUpgrade_helper(dssInstance, dssSolver, dssObjects, dssObjectsByClass, simulationSettings)

Bases: PyDSS.pyPostprocessor.pyPostprocessAbstract.AbstractPostprocess

The class is used to induce faults on bus for dynamic simulation studies. Subclass of the PyDSS.pyControllers.pyControllerAbstract.ControllerAbstract abstract class.

Parameters

• FaultObj (class:PyDSS.dssElement.dssElement) – A PyDSS.dssElement.dssElement object that wraps around an OpenDSS ‘Fault’ element

• Settings (dict) – A dictionary that defines the settings for the faul controller.

• dssInstance (opendssdirect instance) – An opendssdirect instance

• ElmObjectList (dict) – Dictionary of all dssElement, dssBus and dssCircuit ojects

• dssSolver (PyDSS.SolveMode) – An instance of one of the classes defined in PyDSS.SolveMode.

Raises

AssertionError if ‘FaultObj’ is not a wrapped OpenDSS Fault element

run(step, stepMax, simulation=None)

Induces and removes a fault as the simulation runs as per user defined settings.

PyDSS.pyPostprocessor.PostprocessScripts.AutomatedVoltageUpgrade module

class PyDSS.pyPostprocessor.PostprocessScripts.AutomatedVoltageUpgrade.AutomatedVoltageUpgrade(project, scenario, inputs, dssInstance, dssSolver, dssObjects, dssObjectsByClass, simulationSettings, Logger)

Bases: PyDSS.pyPostprocessor.pyPostprocessAbstract.AbstractPostprocess

This class is used to determine Voltage Upgrades

LTC_controls_sweep(upper_limit, lower_limit)

REQUIRED_INPUT_FIELDS = ('target_v', 'initial_voltage_upper_limit', 'initial_voltage_lower_limit', 'final_voltage_upper_limit', 'final_voltage_lower_limit', 'nominal_voltage', 'nominal_pu_voltage', 'tps_to_test', 'create_topology_plots', 'cap_sweep_voltage_gap', 'reg_control_bands', 'reg_v_delta', 'max_regulators', 'use_ltc_placement', 'thermal_scenario_name')

add_new_reg_common_nodes(upper_limit)

add_new_regctrl(node)

add_new_xfmr(node)

add_substation_LTC()

apply_best_LTCsetting(upper_limit)

apply_best_capsetting(upper_limit)

apply_best_regsetting(upper_limit)

apply_orig_LTC_setting()

apply_orig_cap_setting()

apply_orig_reg_setting()

cap_settings_sweep(upper_limit, lower_limit)

check_voltage_violations_multi_tps(upper_limit, lower_limit, raise_exception=True)

check_voltage_violations_multi_tps_individual_object(upper_limit, lower_limit)

cluster_square_array()

compare_objective_function(min_cluster)

correct_cap_bank_settings()

correct_node_coords()

create_final_comparison(project_path=None, thermal_dss_file=None)

create_result_comparison_voltages(comparison_stage='')

disable_added_xfmr(node)

disable_regctrl_current_cluster()

edit_capacitor_settings_for_convergence(control_command)

finalize()

Method used to combine post processing results from all steps.

generate_edges()

All lines, switches, reclosers etc are modeled as lines, so calling lines takes care of all of them. However we also need to loop over transformers as they form the edge between primary and secondary nodes :return:

generate_nodes()

generate_nx_representation()

get_capacitor_state()

get_existing_controller_info()

get_full_distance_dict()

get_load_mults()

get_load_pv_mults_individual_object()

get_min_max_load_mult()

get_shortest_path()

get_viols_with_initial_cap_settings()

identify_correct_reg_node()

plot_created_clusters()

plot_feeder()

plot_heatmap_distmatrix()

plot_violations()

read_load_files(dss_path)

read_load_files_individual_object(key_paths, dss_path)

read_pv_files_individual_object(key_paths, dss_path)

reg_controls_sweep(upper_limit, lower_limit)

run(step, stepMax, simulation=None)

Method used to run a post processing script.

Parameters

• step (int) – Current step

• stepMax (int) – Last step of the simulation

• simulation (OpenDSS) – PyDSS simulation control class. Provided for access to control algorithms. Subclasses should not hold references to this instance after this method exits.

write_dss_file(device_command)

write_to_json(dict, file_name)

write_upgrades_to_file(output_path=None)

PyDSS.pyPostprocessor.PostprocessScripts.AutomatedVoltageUpgrade.get_cap_controls_info()

PyDSS.pyPostprocessor.PostprocessScripts.AutomatedVoltageUpgrade.get_capacitor_info()

PyDSS.pyPostprocessor.PostprocessScripts.AutomatedVoltageUpgrade.get_ckt_info()

PyDSS.pyPostprocessor.PostprocessScripts.AutomatedVoltageUpgrade.get_reg_control_info()

PyDSS.pyPostprocessor.PostprocessScripts.DERMSOptimizer module

class PyDSS.pyPostprocessor.PostprocessScripts.DERMSOptimizer.DERMSOptimizer(project, scenario, inputs, dssInstance, dssSolver, dssObjects, dssObjectsByClass, simulationSettings, Logger)

Bases: PyDSS.pyPostprocessor.pyPostprocessAbstract.AbstractPostprocess

ExtractImpednceMatrix()

IMPLEMENTATION_MODES = ['Continuous', 'Voltage triggered', 'Time triggered', 'Off']

REQUIRED_INPUT_FIELDS_AND_DEFAULTS = {'Distributions': {'Imes': ['norm', [0.0, 0.01]], 'Vmes': ['norm', [0.0, 0.01]]}, 'Vlower': 0.955, 'Vupper': 1.038, 'coeff_p': 0.0005, 'coeff_q': 1e-06, 'control_all_flag': True, 'control_flag': True, 'implementation_mode': 'Voltage triggered', 'max_iterations': 50, 'measurements_noises_flag': True, 'num_DERMS': 1, 'opf_iteration': 60, 'stepsize_mu': 10, 'stepsize_xp': 1, 'stepsize_xq': 5, 'time_trigger_sec': 900}

buses(pv)

calc_node_PQ()

construct_Yprime()

convert_3phasePV_to_1phasePV(PVSystems)

getBranchInfo()

getContolBuses(classNames)

getDERdata()

getPreoptimizationResults()

get_PQ_by_class(className)

get_elem_data(ElementClass, Properties)

get_incidence_matrix()

get_voltage_Yorder()

initialize_optimizer()

run(step, stepMax, simulation=None)

Induces and removes a fault as the simulation runs as per user defined settings.

to_complex(values)

PyDSS.pyPostprocessor.PostprocessScripts.EdLiFoControl module

class PyDSS.pyPostprocessor.PostprocessScripts.EdLiFoControl.EdLiFoControl(project, scenario, inputs, dssInstance, dssSolver, dssObjects, dssObjectsByClass, simulationSettings, Logger)

Bases: PyDSS.pyPostprocessor.pyPostprocessAbstract.AbstractPostprocess

Electric distance last-in First-out curtailment based PV output control

REQUIRED_INPUT_FIELDS = ['curtailment_size', 'electrical_distance_file_path', 'zone_option', 'zone_threshold', 'fixed_pv_path', 'lifo_pv_path', 'lifo_min_pv_size', 'user_lifo_pv_list']

finalize()

Method used to combine post processing results from all steps.

get_curtailment_candidates()

Finds PV units that can be be candidates for curtailment

get_lifo_ordered_list()

Get the last-in first-in ordered PV list

poa_curtail()

Executes curtailment decisions

record_curtailment(pv_sys)

Records PV curtailments

run(step, stepMax, simulation=None)

Runs edLiFo

solve_overloads()

Uses the LiFo logic to solve line and transformer overloads

PyDSS.pyPostprocessor.PostprocessScripts.EdLiFoControl.check_line_overloads(monitored_lines)

Checks line overloads

PyDSS.pyPostprocessor.PostprocessScripts.EdLiFoControl.choose_zone_radius(dismat_df)

Selects a zone radius value that makes sense

PyDSS.pyPostprocessor.PostprocessScripts.EdLiFoControl.compute_electric_distance(bus_phases=None)

This method computes electric distance matrix

PyDSS.pyPostprocessor.PostprocessScripts.EdLiFoControl.form_pvzones(affected_buses, dismat_df, zone_thr)

Builds PV zones

PyDSS.pyPostprocessor.PostprocessScripts.EdLiFoControl.get_g(r_value)

Get conductance values from resistance values

PyDSS.pyPostprocessor.PostprocessScripts.EdLiFoControl.get_monitored_line_dataframe(phase_info=3)

Sample syntax: monitored_lines = get_monitored_line_dataframe()

PyDSS.pyPostprocessor.PostprocessScripts.EdLiFoControl.get_transformer_info()

Gather transformer information

PyDSS.pyPostprocessor.PostprocessScripts.EdLiFoControl.parse_pv_scenario(file_path, min_lifo_pv_size)

Extracts from a PV deployment scenario, parameter information into a dataframe. Sample syntax: PV_dict, PV_dataframe = parse_pv_scenario(deployment_path + deployment_name)

PyDSS.pyPostprocessor.PostprocessScripts.EdLiFoControl.string_attribute_parser(att, line)

Parses attribute value from a line string

PyDSS.pyPostprocessor.PostprocessScripts.Utilidata_Interface module

class PyDSS.pyPostprocessor.PostprocessScripts.Utilidata_Interface.NOAAData(token)

Bases: object

data_categories(**kwargs)

data_types(**kwargs)

dataset_spec(set_code, **kwargs)

datasets(**kwargs)

fetch_data(**kwargs)

location_categories(**kwargs)

locations(**kwargs)

poll_api(req_type, payload)

stations(h, p, **kwargs)

class PyDSS.pyPostprocessor.PostprocessScripts.Utilidata_Interface.Utilidata_Interface(project, scenario, inputs, dssInstance, dssSolver, dssObjects, dssObjectsByClass, simulationSettings, Logger)

Bases: PyDSS.pyPostprocessor.pyPostprocessAbstract.AbstractPostprocess

IMPLEMENTATION_MODES = []

REQUIRED_INPUT_FIELDS_AND_DEFAULTS = {}

create_optimization_model()

define_constraints()

define_metadata()

disable_control_elements()

find_filenames(path_to_dir, suffix='.csv')

get_constraint(elm_name, isControllable)

get_feeder(elm_name)

get_measurement(obj, ppty)

get_measurement_assets(asset_info)

get_measurements()

run(step, stepMax)

Method used to run a post processing script.

Parameters

• step (int) – Current step

• stepMax (int) – Last step of the simulation

• simulation (OpenDSS) – PyDSS simulation control class. Provided for access to control algorithms. Subclasses should not hold references to this instance after this method exits.

submit_operation_payload()

update_system_states(new_settings)

update_training_payload()

PyDSS.pyPostprocessor.PostprocessScripts.postprocess_thermal_upgrades module

class PyDSS.pyPostprocessor.PostprocessScripts.postprocess_thermal_upgrades.postprocess_thermal_upgrades(Settings, dss, logger)

Bases: object

correct_node_coords()

create_edge_node_dicts()

create_op_plots()

generate_edges()

All lines, switches, reclosers etc are modeled as lines, so calling lines takes care of all of them. However we also need to loop over transformers as they form the edge between primary and secondary nodes :return:

generate_nodes()

get_all_parallel()

processed_upgrade_file is the name of the json file written out from Akshay’s thermal upgrades code

get_line_upgrade_params(new_line)

get_orig_line_DT_params()

get_xfmr_upgrade_params(new_line)

parallel_upgrades(equipment_type)

upgrade_df is a dataframe version of the processed_thermal_upgrades.json file produced by Akshay’s upgrade codeself. equipment_type is a string equal to either “Transformer” or “Line”

plot_feeder()

process_thermal_upgrades()

write_to_json(dict, file_name)

PyDSS.pyPostprocessor.PostprocessScripts.postprocess_voltage_upgrades module

PyDSS.pyPostprocessor.PostprocessScripts.postprocess_voltage_upgrades.compare_dict(old, new)

class PyDSS.pyPostprocessor.PostprocessScripts.postprocess_voltage_upgrades.postprocess_voltage_upgrades(Settings, logger)

Bases: object

check_substation_LTC()

get_capacitor_upgrades()

get_regulator_upgrades()

write_to_json(dict, file_name)

Module contents