Contents¶
- Overview
- Installation
- How to Use py-dss-interface Python package
- Source Code Documentation
- py_dss_interface package
- ActiveClass
- Bus
Bus
Bus.all_pce_active_bus
Bus.all_pde_active_bus
Bus.axc_012_matrix
Bus.bus_lambda
Bus.coord_defined
Bus.cplx_sequence_voltages
Bus.distance
Bus.interruptions_avg_duration
Bus.interruptions_num
Bus.interruptions_total_customers
Bus.isc
Bus.kv_base
Bus.latitude
Bus.line_list
Bus.line_total_miles
Bus.load_list
Bus.longitude
Bus.name
Bus.nodes
Bus.num_nodes
Bus.outage_customer_accum_duration
Bus.pu_vll
Bus.pu_voltages
Bus.section_id
Bus.seq_voltages
Bus.total_customers
Bus.unique_node_number
Bus.vll
Bus.vmag_angle
Bus.vmag_angle_pu
Bus.voc
Bus.voltages
Bus.x
Bus.y
Bus.ysc_matrix
Bus.zsc0
Bus.zsc1
Bus.zsc_matrix
Bus.zsc_refresh
- Capacitors
Capacitors
Capacitors.add_step()
Capacitors.available_steps
Capacitors.close_all_steps()
Capacitors.count
Capacitors.first()
Capacitors.is_delta
Capacitors.kv
Capacitors.kvar
Capacitors.name
Capacitors.names
Capacitors.next()
Capacitors.num_steps
Capacitors.open_all_steps()
Capacitors.states
Capacitors.subtract_step()
- CapControls
CapControls
CapControls.controlled_capacitor
CapControls.count
CapControls.ct_ratio
CapControls.dead_time
CapControls.delay
CapControls.delay_off
CapControls.first()
CapControls.mode
CapControls.monitored_object
CapControls.monitored_term
CapControls.name
CapControls.names
CapControls.next()
CapControls.off_setting
CapControls.on_setting
CapControls.pt_ratio
CapControls.use_volt_override
CapControls.vmax
CapControls.vmin
- Circuit
Circuit
Circuit.buses_distances
Circuit.buses_names
Circuit.buses_vmag
Circuit.buses_vmag_pu
Circuit.buses_volts
Circuit.capacity
Circuit.disable
Circuit.elements_losses
Circuit.elements_names
Circuit.enable
Circuit.end_of_time_step_update
Circuit.first_element()
Circuit.line_losses
Circuit.losses
Circuit.name
Circuit.next_element()
Circuit.nodes_distances
Circuit.nodes_distances_by_phase()
Circuit.nodes_names
Circuit.nodes_names_by_phase()
Circuit.nodes_vmag_by_phase()
Circuit.nodes_vmag_pu_by_phase()
Circuit.num_buses
Circuit.num_ckt_elements
Circuit.num_nodes
Circuit.parent_pd_element
Circuit.pc_element_first()
Circuit.pc_element_next()
Circuit.pd_element_first()
Circuit.pd_element_next()
Circuit.sample
Circuit.save_sample
Circuit.set_active_bus()
Circuit.set_active_bus_i()
Circuit.set_active_class()
Circuit.set_active_element()
Circuit.substation_losses
Circuit.system_y
Circuit.total_power
Circuit.update_storage_t
Circuit.y_currents
Circuit.y_node_order
Circuit.y_node_varray
- CktElement
CktElement
CktElement.bus_names
CktElement.close_terminal()
CktElement.controller()
CktElement.cplx_seq_currents
CktElement.cplx_seq_voltages
CktElement.currents
CktElement.currents_mag_ang
CktElement.display
CktElement.emerg_amps
CktElement.enabled()
CktElement.energymeter
CktElement.guid
CktElement.has_switch_control
CktElement.has_volt_control
CktElement.is_enabled
CktElement.is_terminal_open
CktElement.losses
CktElement.name
CktElement.node_order
CktElement.norm_amps
CktElement.num_conductors
CktElement.num_controls
CktElement.num_phases
CktElement.num_properties
CktElement.num_terminals
CktElement.ocp_dev_index
CktElement.ocp_dev_type
CktElement.open_terminal()
CktElement.phase_losses
CktElement.powers
CktElement.property_names
CktElement.residuals_currents
CktElement.seq_currents
CktElement.seq_powers
CktElement.seq_voltages
CktElement.variable_i()
CktElement.variables_names
CktElement.variables_values
CktElement.voltages
CktElement.voltages_mag_ang
CktElement.y_prim
- CMathLib
- CtrlQueue
- DSSElement
- DSSExecutive
- DSSInterface
DSSInterface
DSSInterface.allow_forms
DSSInterface.classes
DSSInterface.clear_all()
DSSInterface.datapath
DSSInterface.default_editor
DSSInterface.new_circuit()
DSSInterface.num_circuits
DSSInterface.num_classes
DSSInterface.num_user_classes
DSSInterface.reset()
DSSInterface.show_panel()
DSSInterface.start()
DSSInterface.user_classes
DSSInterface.version
- DSSProgress
- DSSProperties
- ErrorInterface
- Fuses
- Generators
Generators
Generators.count
Generators.first()
Generators.forced_on
Generators.idx
Generators.kv
Generators.kva
Generators.kvar
Generators.kw
Generators.model
Generators.name
Generators.names
Generators.next()
Generators.pf
Generators.phases
Generators.register_names
Generators.register_values
Generators.vmax_pu
Generators.vmin_pu
- ISources
- LineCodes
LineCodes
LineCodes.c0
LineCodes.c1
LineCodes.cmatrix
LineCodes.count
LineCodes.emerg_amps
LineCodes.first()
LineCodes.is_z1z0
LineCodes.name
LineCodes.names
LineCodes.next()
LineCodes.norm_amps
LineCodes.phases
LineCodes.r0
LineCodes.r1
LineCodes.rmatrix
LineCodes.units
LineCodes.x0
LineCodes.x1
LineCodes.xmatrix
- Lines
Lines
Lines.bus1
Lines.bus2
Lines.c0
Lines.c1
Lines.cmatrix
Lines.count
Lines.emerg_amps
Lines.first()
Lines.geometry
Lines.length
Lines.linecode
Lines.name
Lines.names
Lines.next()
Lines.norm_amps
Lines.num_cust
Lines.parent
Lines.phases
Lines.r0
Lines.r1
Lines.rg
Lines.rho
Lines.rmatrix
Lines.season_rating
Lines.spacing
Lines.units
Lines.x0
Lines.x1
Lines.xg
Lines.xmatrix
Lines.yprim
- Loads
Loads
Loads.allocation_factor
Loads.c_factor
Loads.class_number
Loads.count
Loads.cvr_curve
Loads.cvr_vars
Loads.cvr_watts
Loads.daily
Loads.duty
Loads.first()
Loads.growth
Loads.idx
Loads.is_delta
Loads.kv
Loads.kva
Loads.kvar
Loads.kw
Loads.kwh
Loads.kwh_days
Loads.model
Loads.name
Loads.names
Loads.next()
Loads.num_cust
Loads.pct_mean
Loads.pct_std_dev
Loads.pf
Loads.r_neut
Loads.rel_weight
Loads.rl
Loads.spectrum
Loads.status
Loads.vmax_pu
Loads.vmin_emerg
Loads.vmin_norm
Loads.vmin_pu
Loads.x_neut
Loads.xfkva
Loads.yearly
Loads.zipv
- LoadShapes
LoadShapes
LoadShapes.count
LoadShapes.first()
LoadShapes.hr_interval
LoadShapes.min_interval
LoadShapes.name
LoadShapes.names
LoadShapes.next()
LoadShapes.normalize()
LoadShapes.npts
LoadShapes.p_base
LoadShapes.p_mult
LoadShapes.q_base
LoadShapes.q_mult
LoadShapes.s_interval
LoadShapes.time_array
LoadShapes.use_actual
- Meters
Meters
Meters.all_branches_in_zone
Meters.all_end_elements
Meters.all_pce_in_zone
Meters.alloc_factors
Meters.avg_repair_time
Meters.calc_current
Meters.close_all_di_files()
Meters.count
Meters.count_branches
Meters.count_end_elements
Meters.cust_interrupts
Meters.di_files_are_open
Meters.do_reliability_calc()
Meters.fault_rate_x_repair_hrs
Meters.first()
Meters.metered_element
Meters.metered_terminal
Meters.name
Meters.names
Meters.next()
Meters.num_section_branches
Meters.num_section_customers
Meters.num_sections
Meters.ocp_device_type
Meters.open_all_di_files()
Meters.peak_current
Meters.register_names
Meters.register_values
Meters.reset()
Meters.reset_all()
Meters.saidi
Meters.saifi
Meters.saifi_kw
Meters.sample()
Meters.sample_all()
Meters.save()
Meters.save_all()
Meters.sect_seq_idx
Meters.sect_total_cust
Meters.seq_list_size
Meters.sequence_index
Meters.set_active_section()
Meters.sum_branch_flt_rates
Meters.total_customers
Meters.totals
- Monitors
Monitors
Monitors.byte_stream
Monitors.channel()
Monitors.count
Monitors.dbl_freq
Monitors.dbl_hour
Monitors.element
Monitors.file_name
Monitors.file_version
Monitors.first()
Monitors.header
Monitors.mode
Monitors.name
Monitors.names
Monitors.next()
Monitors.num_channels
Monitors.process()
Monitors.process_all()
Monitors.record_size
Monitors.reset()
Monitors.reset_all()
Monitors.sample()
Monitors.sample_all()
Monitors.sample_count
Monitors.save()
Monitors.save_all()
Monitors.show()
Monitors.terminal
- Parallel
- Parser
- PDElements
PDElements
PDElements.accumulated_failure_rate
PDElements.branch_failure_rate
PDElements.count
PDElements.fault_rate
PDElements.first()
PDElements.from_terminal
PDElements.is_shunt
PDElements.name
PDElements.next()
PDElements.num_customers
PDElements.parent_pd_element
PDElements.pct_permanent
PDElements.repair_time
PDElements.section_id
PDElements.total_customers
PDElements.total_miles
- PVSystems
- Reclosers
Reclosers
Reclosers.close()
Reclosers.count
Reclosers.first()
Reclosers.ground_inst
Reclosers.ground_trip
Reclosers.idx
Reclosers.intervals
Reclosers.monitored_obj
Reclosers.monitored_term
Reclosers.name
Reclosers.names
Reclosers.next()
Reclosers.num_fast
Reclosers.open()
Reclosers.phase_inst
Reclosers.phase_trip
Reclosers.shots
Reclosers.switched_obj
Reclosers.switched_term
- RegControls
RegControls
RegControls.count
RegControls.ct_primary
RegControls.delay
RegControls.first()
RegControls.forward_band
RegControls.forward_r
RegControls.forward_vreg
RegControls.forward_x
RegControls.is_inverse_time
RegControls.is_reversible
RegControls.max_tap_change
RegControls.monitored_bus
RegControls.name
RegControls.names
RegControls.next()
RegControls.pt_ratio
RegControls.reverse_band
RegControls.reverse_r
RegControls.reverse_vreg
RegControls.reverse_x
RegControls.tap_delay
RegControls.tap_number
RegControls.tap_winding
RegControls.transformer
RegControls.voltage_limit
RegControls.winding
- Relays
- Sensors
- Settings
Settings
Settings.allocation_factors
Settings.allow_duplicates
Settings.auto_bus_list
Settings.ckt_model
Settings.emerg_vmax_pu
Settings.emerg_vmin_pu
Settings.loss_regs
Settings.loss_weight
Settings.norm_vmax_pu
Settings.norm_vmin_pu
Settings.price_curve
Settings.price_signal
Settings.trapezoidal
Settings.ue_regs
Settings.ue_weight
Settings.voltage_bases
Settings.zone_lock
- Solution
Solution
Solution.add_type
Solution.algorithm
Solution.build_y_matrix()
Solution.bus_levels
Solution.calc_inc_matrix()
Solution.calc_inc_matrix_0()
Solution.cap_kvar
Solution.check_controls()
Solution.check_fault_status()
Solution.clean_up()
Solution.control_actions_done
Solution.control_iterations
Solution.control_mode
Solution.converged
Solution.dbl_hour
Solution.default_daily
Solution.default_yearly
Solution.do_control_actions()
Solution.event_log
Solution.finish_time_step()
Solution.frequency
Solution.gen_kw
Solution.gen_mult
Solution.gen_pf
Solution.hour
Solution.inc_matrix_cols
Solution.inc_matrix_rows
Solution.init_snap()
Solution.iterations
Solution.laplacian
Solution.ld_curve
Solution.load_model
Solution.load_mult
Solution.max_control_iterations
Solution.max_iterations
Solution.mode
Solution.mode_id
Solution.most_iterations_done
Solution.nc_matrix
Solution.number
Solution.pct_growth
Solution.process_time
Solution.process_time_step
Solution.random
Solution.sample_control_devices()
Solution.sample_do_control_actions()
Solution.seconds
Solution.solve()
Solution.solve_all()
Solution.solve_direct()
Solution.solve_no_control()
Solution.solve_plus_control()
Solution.solve_power_flow()
Solution.step_size
Solution.step_size_hr
Solution.step_size_min
Solution.system_y_changed
Solution.tolerance
Solution.total_iterations
Solution.total_time
Solution.year
- SwtControls
- Text
- Topology
Topology
Topology.active_branch
Topology.active_level
Topology.all_isolated_branches
Topology.all_isolated_loads
Topology.all_looped_pairs
Topology.backward_branch()
Topology.branch_name
Topology.bus_name
Topology.first()
Topology.first_load()
Topology.forward_branch()
Topology.looped_branch()
Topology.next()
Topology.next_load()
Topology.num_isolated_branches
Topology.num_isolated_loads
Topology.num_loops
Topology.parallel_branch()
- Transformers
Transformers
Transformers.count
Transformers.first()
Transformers.is_delta
Transformers.kv
Transformers.kva
Transformers.max_tap
Transformers.min_tap
Transformers.name
Transformers.names
Transformers.next()
Transformers.num_taps
Transformers.num_windings
Transformers.r
Transformers.r_neut
Transformers.str_wdg_voltages
Transformers.tap
Transformers.wdg
Transformers.wdg_currents
Transformers.wdg_voltages
Transformers.x_neut
Transformers.xfmr_code
Transformers.xhl
Transformers.xht
Transformers.xlt
- VSources
- XYCurves
- py_dss_interface package
- Indices and Tables
- Contributing
- Credits
- Changelog