Skip to content

Commit

Permalink
updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AadilLatif committed Sep 30, 2024
1 parent 56a8cce commit f280424
Show file tree
Hide file tree
Showing 32 changed files with 64 additions and 24 deletions.
14 changes: 12 additions & 2 deletions docs/source/_autosummary/PyDSS.api.src.app.pydss.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
pydss.api.src.app.pydss
pydss.api.src.app.pydss
=======================

.. automodule:: pydss.api.src.app.pydss











.. rubric:: Classes

.. autosummary::

pydss
PyDSS



Expand Down
3 changes: 2 additions & 1 deletion docs/source/_autosummary/PyDSS.pyControllers.Controllers.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
pydss.pyControllers.Controllers
pydss.pyControllers.Controllers
===============================

.. automodule:: pydss.pyControllers.Controllers
Expand Down Expand Up @@ -27,6 +27,7 @@ pydss.pyControllers.Controllers
:toctree:
:recursive:

pydss.pyControllers.Controllers.DynamicVoltageSupport
pydss.pyControllers.Controllers.FaultController
pydss.pyControllers.Controllers.GenController
pydss.pyControllers.Controllers.MotorStall
Expand Down
4 changes: 1 addition & 3 deletions docs/source/_autosummary/PyDSS.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

Pydss
pydss
=====

.. automodule:: pydss
Expand Down Expand Up @@ -60,7 +59,6 @@ Pydss
pydss.pyContrReader
pydss.pyControllers
pydss.pyDSS
pydss.pyPlotReader
pydss.pyPostprocessor
pydss.pyResults
pydss.pydss_fs_interface
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
pydss.pyControllers.Controllers.DynamicVoltageSupport
=====================================================

.. automodule:: pydss.pyControllers.Controllers.DynamicVoltageSupport











.. rubric:: Classes

.. autosummary::

DynamicVoltageSupport









Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
**********************************
Dynamic Voltage Support Controller
==================================
**********************************
(DynamicVoltageSupport.py)

The DynamicVoltageSupport (DVS) controller will control the DER to
Expand Down
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
3 changes: 2 additions & 1 deletion docs/source/controllers_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,5 @@ Controller Documentation
controllers/SocketController.rst
controllers/StorageController.rst
controllers/ThermostaticLoad.rst
controllers/xfmrController.rst
controllers/xfmrController.rst
controllers/dynamic_voltage_support.rst
6 changes: 3 additions & 3 deletions examples/dynamics/Exports/fault/CapacitorsInfo.csv
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
,bus1,bus2,phases,kvar,kv,conn,cmatrix,cuf,R,XL,Harm,Numsteps,states,normamps,emergamps,faultrate,pctperm,repair,basefreq,enabled,like
Capacitor.c1,b1,b1.0.0.0,3,['600'],12.47,wye,"('0 |4.88117258506981E-310 7.77679460436692E-306 |7.76946392020825E-306 7.76946401854707E-306 7.76986216447027E-306',)",['10.235'],['0'],['0'],['0'],1,['1'],37.5023029706172,50.0030706274896,0.0005,100,3,60,Yes,
Capacitor.c2,b3,b3.0.0.0,3,['600'],12.47,wye,"('0 |4.15588105495473E-310 7.7767946321927E-306 |0 0 0',)",['10.235'],['0'],['0'],['0'],1,['1'],37.5023029706172,50.0030706274896,0.0005,100,3,60,Yes,
Capacitor.cg,bg,bg.0.0.0,3,['600'],0.48,wye,"('0 |5.91730334237707E-310 2.25615260570573E-308 |7.76987919930038E-306 0 7.77679210032365E-306',)",['6907.77'],['0'],['0'],['0'],1,['1'],974.278579257494,1299.03810567666,0.0005,100,3,60,Yes,
Capacitor.c1,b1,b1.0.0.0,3,['600'],12.47,wye,"('0 |4.88117258506981E-310 1.05821896968903E-305 |1.05855341594194E-305 1.05855341698541E-305 1.05855342014743E-305',)",['10.235'],['0'],['0'],['0'],1,['1'],37.5023029706172,50.0030706274896,0.0005,100,3,60,Yes,
Capacitor.c2,b3,b3.0.0.0,3,['600'],12.47,wye,"('0 |4.15588105495473E-310 1.05821897247161E-305 |0 0 0',)",['10.235'],['0'],['0'],['0'],1,['1'],37.5023029706172,50.0030706274896,0.0005,100,3,60,Yes,
Capacitor.cg,bg,bg.0.0.0,3,['600'],0.48,wye,"('0 |5.91730334237707E-310 2.25615260570573E-308 |1.05855428827215E-305 0 1.05821868688981E-305',)",['6907.77'],['0'],['0'],['0'],1,['1'],974.278579257494,1299.03810567666,0.0005,100,3,60,Yes,
2 changes: 1 addition & 1 deletion examples/harmonics/Exports/qsts/CapacitorsInfo.csv
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
,bus1,bus2,phases,kvar,kv,conn,cmatrix,cuf,R,XL,Harm,Numsteps,states,normamps,emergamps,faultrate,pctperm,repair,basefreq,enabled,like
Capacitor.c83,83,83.0.0.0,3,['600'],4.16,wye,"('0 |6.0209164181078E-310 7.77679462460385E-306 |7.76986230612877E-306 7.76986223941015E-306 7.76946401380404E-306',)",['91.9673'],['0'],['0'],['0'],1,['1'],112.416759145095,149.889012193461,0.0005,100,3,60,Yes,
Capacitor.c83,83,83.0.0.0,3,['600'],4.16,wye,"('0 |6.0209164181078E-310 1.05821897171272E-305 |1.05855340395789E-305 1.05855341145187E-305 1.05855342255056E-305',)",['91.9673'],['0'],['0'],['0'],1,['1'],112.416759145095,149.889012193461,0.0005,100,3,60,Yes,
Capacitor.c88a,88.1,88.0.0.0,1,['50'],2.402,wye,"('0',)",['22.9876'],['0'],['0'],['0'],1,['1'],28.1015820149875,37.4687760199833,0.0005,100,3,60,Yes,
Capacitor.c90b,90.2,90.0.0.0,1,['50'],2.402,wye,"('0',)",['22.9876'],['0'],['0'],['0'],1,['1'],28.1015820149875,37.4687760199833,0.0005,100,3,60,Yes,
Capacitor.c92c,92.3,92.0.0.0,1,['50'],2.402,wye,"('0',)",['22.9876'],['0'],['0'],['0'],1,['1'],28.1015820149875,37.4687760199833,0.0005,100,3,60,Yes,
2 changes: 1 addition & 1 deletion examples/harmonics/Exports/static/CapacitorsInfo.csv
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
,bus1,bus2,phases,kvar,kv,conn,cmatrix,cuf,R,XL,Harm,Numsteps,states,normamps,emergamps,faultrate,pctperm,repair,basefreq,enabled,like
Capacitor.c83,83,83.0.0.0,3,['600'],4.16,wye,"('0 |4.88117258506981E-310 7.77679460436692E-306 |7.76946392020825E-306 7.76946401854707E-306 7.76986216447027E-306',)",['91.9673'],['0'],['0'],['0'],1,['1'],112.416759145095,149.889012193461,0.0005,100,3,60,Yes,
Capacitor.c83,83,83.0.0.0,3,['600'],4.16,wye,"('0 |4.88117258506981E-310 1.05821896968903E-305 |1.05855341594194E-305 1.05855341698541E-305 1.05855342014743E-305',)",['91.9673'],['0'],['0'],['0'],1,['1'],112.416759145095,149.889012193461,0.0005,100,3,60,Yes,
Capacitor.c88a,88.1,88.0.0.0,1,['50'],2.402,wye,"('0',)",['22.9876'],['0'],['0'],['0'],1,['1'],28.1015820149875,37.4687760199833,0.0005,100,3,60,Yes,
Capacitor.c90b,90.2,90.0.0.0,1,['50'],2.402,wye,"('0',)",['22.9876'],['0'],['0'],['0'],1,['1'],28.1015820149875,37.4687760199833,0.0005,100,3,60,Yes,
Capacitor.c92c,92.3,92.0.0.0,1,['50'],2.402,wye,"('0',)",['22.9876'],['0'],['0'],['0'],1,['1'],28.1015820149875,37.4687760199833,0.0005,100,3,60,Yes,
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"FeederHeadLine": "Line.sl_9", "FeederHeadLoading": 0.004027866122893067, "FeederHeadLoadKW": -0.23217998318599928, "FeederHeadLoadKVar": -0.02565294947761661, "ReversePowerFlow": false}
{"FeederHeadLine": "Line.sl_9", "FeederHeadLoading": 0.0046604372733127595, "FeederHeadLoadKW": -0.26338670507973566, "FeederHeadLoadKVar": -0.02957694887643677, "ReversePowerFlow": false}
8 changes: 4 additions & 4 deletions examples/monte_carlo/Exports/scenario_1/LoadsInfo.csv
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
,phases,bus1,kV,kW,pf,model,yearly,daily,duty,growth,conn,kvar,Rneut,Xneut,status,class,Vminpu,Vmaxpu,Vminnorm,Vminemerg,xfkVA,allocationfactor,kVA,%mean,%stddev,CVRwatts,CVRvars,kwh,kwhdays,Cfactor,CVRcurve,NumCust,ZIPV,%SeriesRL,RelWeight,Vlowpu,puXharm,XRharm,spectrum,basefreq,enabled,like
Load.mpx000635970,1,110_2.1,0.24,0.074918308348582,0.987278887205994,1,lp_mpx000635970,,,,wye,0.0120653541376679,-1,0,Variable,1,0.95,1.05,0,0,0,0.5,0.0758836325980811,50,10,1,2,0,30,4,,1,['0 0 0 0 0 0 0'],50,1,0.5,0,6,defaultload,60,Yes,
Load.mpx000460267,1,111_2.1,0.24,0.500665533889781,0.985668177157945,1,lp_mpx000460267,,,,wye,0.0856881987126773,-1,0,Variable,1,0.95,1.05,0,0,0,0.5,0.507945316174648,50,10,1,2,0,30,4,,1,['0 0 0 0 0 0 0'],50,1,0.5,0,6,defaultload,60,Yes,
Load.mpx000637601,1,112_2.1,0.24,0.0902463386860165,0.891350249023867,1,lp_mpx000637601,,,,wye,0.0458967093888884,-1,0,Variable,1,0.95,1.05,0,0,0,0.5,0.101246775647224,50,10,1,2,0,30,4,,1,['0 0 0 0 0 0 0'],50,1,0.5,0,6,defaultload,60,Yes,
Load.mpx000594341,1,113_2.1,0.24,0.229702948078242,0.988083581678164,1,lp_mpx000594341,,,,wye,0.0357818734817596,-1,0,Variable,1,0.95,1.05,0,0,0,0.5,0.232473195929553,50,10,1,2,0,30,4,,1,['0 0 0 0 0 0 0'],50,1,0.5,0,6,defaultload,60,Yes,
Load.mpx000635970,1,110_2.1,0.24,0.0239733750855231,0.987278887205994,1,lp_mpx000635970,,,,wye,0.00386083544407014,-1,0,Variable,1,0.95,1.05,0,0,0,0.5,0.024282272614345,50,10,1,2,0,30,4,,1,['0 0 0 0 0 0 0'],50,1,0.5,0,6,defaultload,60,Yes,
Load.mpx000460267,1,111_2.1,0.24,0.461828151684661,0.985668177157945,1,lp_mpx000460267,,,,wye,0.0790412356233323,-1,0,Variable,1,0.95,1.05,0,0,0,0.5,0.468543230254513,50,10,1,2,0,30,4,,1,['0 0 0 0 0 0 0'],50,1,0.5,0,6,defaultload,60,Yes,
Load.mpx000637601,1,112_2.1,0.24,0.154537295636797,0.891350249023867,1,lp_mpx000637601,,,,wye,0.0785932532095712,-1,0,Variable,1,0.95,1.05,0,0,0,0.5,0.173374378709193,50,10,1,2,0,30,4,,1,['0 0 0 0 0 0 0'],50,1,0.5,0,6,defaultload,60,Yes,
Load.mpx000594341,1,113_2.1,0.24,0.270670588950865,0.988083581678164,1,lp_mpx000594341,,,,wye,0.0421635893230861,-1,0,Variable,1,0.95,1.05,0,0,0,0.5,0.273934911954672,50,10,1,2,0,30,4,,1,['0 0 0 0 0 0 0'],50,1,0.5,0,6,defaultload,60,Yes,
10 changes: 5 additions & 5 deletions examples/monte_carlo/Exports/scenario_1/PVSystemsInfo.csv
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
,phases,bus1,kv,irradiance,Pmpp,%Pmpp,Temperature,pf,conn,kvar,kVA,%Cutin,%Cutout,EffCurve,P-TCurve,%R,%X,model,Vminpu,Vmaxpu,Balanced,LimitCurrent,yearly,daily,duty,Tyearly,Tdaily,Tduty,class,UserModel,UserData,debugtrace,VarFollowInverter,DutyStart,WattPriority,PFPriority,%PminNoVars,%PminkvarMax,kvarMax,kvarMaxAbs,kVDC,Kp,PITol,SafeVoltage,SafeMode,DynamicEq,DynOut,ControlMode,AmpLimit,AmpLimitGain,spectrum,basefreq,enabled,like
PVSystem.pvgnem_mpx000635970,1,110-pv.1,0.24,1,20,100,25,0.974253044246276,wye,0,9.8337073686548,20,20,,,50,0,1,0.9,1.1,No,No,pv_mpx000635970,,,,,,1,,,No,No,0,No,No,-1,-1,9.8337073686548,9.8337073686548,8,0.01,0,80,No,,[],GFL,-1,0.8,,60,Yes,
PVSystem.pvgnem_mpx000460267,1,111-pv.1,0.24,1,8.5,100,25,0.953993609361775,wye,0,10.0150011434643,20,20,,,50,0,1,0.9,1.1,No,No,pv_mpx000460267,,,,,,1,,,No,No,0,No,No,-1,-1,10.0150011434643,10.0150011434643,8,0.01,0,80,No,,[],GFL,-1,0.8,,60,Yes,
PVSystem.pvgnem_mpx000594341,1,113-pv.1,0.24,1,4.6,100,25,0.961147005443298,wye,0,9.95090401399092,20,20,,,50,0,1,0.9,1.1,No,No,pv_mpx000594341,,,,,,1,,,No,No,0,No,No,-1,-1,9.95090401399092,9.95090401399092,8,0.01,0,80,No,,[],GFL,-1,0.8,,60,Yes,
PVSystem.pvgui_mpx000637601,1,112-pv.1,0.24,1.01069592198581,5.5,100,25,0.953522601120221,wye,0,10.044955049881,20,20,,,50,0,1,0.9,1.1,No,No,pv_mpx000637601,,,,,,1,,,No,No,0,No,No,-1,-1,10.044955049881,10.044955049881,8,0.01,0,80,No,,[],GFL,-1,0.8,,60,Yes,
PVSystem.pvgui_mpx000460267,1,111-pv.1,0.24,0.925303188892118,3.9,100,25,0.973874838129,wye,0,9.88235756969248,20,20,,,50,0,1,0.9,1.1,No,No,pv_mpx000460267,,,,,,1,,,No,No,0,No,No,-1,-1,9.88235756969248,9.88235756969248,8,0.01,0,80,No,,[],GFL,-1,0.8,,60,Yes,
PVSystem.pvgnem_mpx000635970,1,110-pv.1,0.24,1,20,100,25,0.973224829133526,wye,0,9.89560240896246,20,20,,,50,0,1,0.9,1.1,No,No,pv_mpx000635970,,,,,,1,,,No,No,0,No,No,-1,-1,9.89560240896246,9.89560240896246,8,0.01,0,80,No,,[],GFL,-1,0.8,,60,Yes,
PVSystem.pvgnem_mpx000460267,1,111-pv.1,0.24,1,8.5,100,25,0.970804892545319,wye,0,10.0337266291473,20,20,,,50,0,1,0.9,1.1,No,No,pv_mpx000460267,,,,,,1,,,No,No,0,No,No,-1,-1,10.0337266291473,10.0337266291473,8,0.01,0,80,No,,[],GFL,-1,0.8,,60,Yes,
PVSystem.pvgnem_mpx000594341,1,113-pv.1,0.24,1,4.6,100,25,0.950707858764007,wye,0,10.1936050846383,20,20,,,50,0,1,0.9,1.1,No,No,pv_mpx000594341,,,,,,1,,,No,No,0,No,No,-1,-1,10.1936050846383,10.1936050846383,8,0.01,0,80,No,,[],GFL,-1,0.8,,60,Yes,
PVSystem.pvgui_mpx000637601,1,112-pv.1,0.24,1.01069592198581,5.5,100,25,0.972387744569397,wye,0,10.0636043126237,20,20,,,50,0,1,0.9,1.1,No,No,pv_mpx000637601,,,,,,1,,,No,No,0,No,No,-1,-1,10.0636043126237,10.0636043126237,8,0.01,0,80,No,,[],GFL,-1,0.8,,60,Yes,
PVSystem.pvgui_mpx000460267,1,111-pv.1,0.24,0.925303188892118,3.9,100,25,0.970352187222238,wye,0,9.84803539564214,20,20,,,50,0,1,0.9,1.1,No,No,pv_mpx000460267,,,,,,1,,,No,No,0,No,No,-1,-1,9.84803539564214,9.84803539564214,8,0.01,0,80,No,,[],GFL,-1,0.8,,60,Yes,
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
,phases,windings,wdg,bus,conn,kV,kVA,tap,%R,Rneut,Xneut,buses,conns,kVs,kVAs,taps,XHL,XHT,XLT,Xscarray,thermal,n,m,flrise,hsrise,%loadloss,%noloadloss,normhkVA,emerghkVA,sub,MaxTap,MinTap,NumTaps,subname,%imag,ppm_antifloat,%Rs,bank,XfmrCode,XRConst,X12,X13,X23,LeadLag,WdgCurrents,Core,RdcOhms,Seasons,Ratings,normamps,emergamps,faultrate,pctperm,repair,basefreq,enabled,like
Transformer.tsf,1,2,2,tsf.1,wye,0.24,37.5,1,0.38195,-1,0,"['sourcebus.1', 'tsf.1']","['wye', 'wye']","['7.2', '0.24']","['37.5', '37.5']","['1', '1']",2.1,35,30,['2.1'],2,0.8,0.8,65,15,0.7639,0.0851,41.25,50,No,1.1,0.9,32,,0,1,"['0.38195', '0.38195']",,,No,2.1,35,30,Lag,"0.03163328, (-6.3049), 0.8135723, (172.65), ",shell,0.0049867392,1,['1100'],5.72916666666667,6.94444444444444,0.007,0,0,60,Yes,
Transformer.tsf,1,2,2,tsf.1,wye,0.24,37.5,1,0.38195,-1,0,"['sourcebus.1', 'tsf.1']","['wye', 'wye']","['7.2', '0.24']","['37.5', '37.5']","['1', '1']",2.1,35,30,['2.1'],2,0.8,0.8,65,15,0.7639,0.0851,41.25,50,No,1.1,0.9,32,,0,1,"['0.38195', '0.38195']",,,No,2.1,35,30,Lag,"0.03589217, (-6.4072), 0.9413519, (172.68), ",shell,0.0049867392,1,['1100'],5.72916666666667,6.94444444444444,0.007,0,0,60,Yes,

0 comments on commit f280424

Please sign in to comment.