added generator functionality, added tests and modified pv system

Author: amzhao16

pygridsim/__pycache__/core.cpython-312.pyc

@@ -2,11 +2,11 @@
 from altdss import altdss
 from altdss import AltDSS, Transformer, Vsource, Load, LoadModel, LoadShape
 from dss.enums import LineUnits, SolveModes
-from pygridsim.parameters import make_load_node, make_source_node, make_pv
+from pygridsim.parameters import *
 from pygridsim.results import query_solution, export_results
 from pygridsim.lines import make_line
 from pygridsim.transformers import make_transformer
-from pygridsim.enums import LineType, SourceType, LoadType
+from pygridsim.enums import LineType, SourceType, LoadType, GeneratorType
 
 """Main module."""
 
@@ -19,6 +19,7 @@ def __init__(self):
 		self.num_lines = 0
 		self.num_transformers = 0
 		self.num_pv = 0
+		self.num_generators = 0
 		altdss.ClearAll()
 		altdss('new circuit.MyCircuit')
 
@@ -34,7 +35,7 @@ def add_load_nodes(self, params = {}, load_type: LoadType = LoadType.HOUSE, num
 			List of load_nodes
 		"""
 		load_nodes = []
-		for i in range(num):
+		for _ in range(num):
 			make_load_node(params, load_type, self.num_loads)
 			self.num_loads += 1
 		return load_nodes
@@ -54,7 +55,7 @@ def update_source(self, params = {}, source_type: SourceType = SourceType.TURBIN
 		"""
 		return make_source_node(params, source_type)
 
-	def add_PVSystem(self, load_nodes = [], params = {}, num_panels = 1):
+	def add_PVSystem(self, load_nodes, params = {}, num_panels = 1):
 		"""
 		Specify a list of load nodes to add a PVsystem ("solar panel") to.
 
@@ -65,22 +66,30 @@ def add_PVSystem(self, load_nodes = [], params = {}, num_panels = 1):
 		Return:
 			list of PVSystem objects
 		"""
+		if not load_nodes:
+			raise ValueError("Need to enter load nodes to add PVSystem to")
 		PV_nodes = []
 		for load in load_nodes:
 			PV_nodes.append(make_pv(load, params, num_panels, self.num_pv))
 			self.num_pv += 1
 		return PV_nodes
 
-	def add_generator(self, params = {}):
+	def add_generator(self, num, params = {}, gen_type: GeneratorType = GeneratorType.SMALL):
 		"""
 		Specify parameters for a generator to add to the circuit
 
 		Args:
-			params: specify anything else about the PVsystem. otherwise defaults to typical solar panel
-			num: representing how many solar panels (to represent scale)
+			num: number of generators
+			gen_type: specify the generator type (small, large, industrial)
+			params: specify anything else about the generator.
 		Return:
-			list of PVSystem objects
+			list of generator objects
 		"""
+		generators = []
+		for _ in range(num):
+			generators.append(make_generator(params, gen_type, count=self.num_generators))
+			self.num_generators += 1
+		return generators
 
 
 	def add_lines(self, connections, line_type: LineType = LineType.LV_LINE, params = {}, transformer = True):

pygridsim/__pycache__/defaults.cpython-312.pyc

@@ -53,6 +53,15 @@
 SOLAR_PANEL_BASE_KV = [0.2, 0.4] # per solar panel
 IMPEDANCE = 0.0001
 
+"""
+Generator default values (small, large, industrial)
+"""
+SMALL_GEN_KV = [0.2, 0.6]
+LARGE_GEN_KV = [1, 35]
+INDUSTRIAL_GEN_KV = [35, 100]
+SMALL_GEN_KW = [2,5]
+LARGE_GEN_KW = [5,10]
+INDUSTRIAL_GEN_KW = [10,20]
 
 """
 Units: KM
@@ -75,4 +84,6 @@
 """
 VALID_LOAD_PARAMS = ["kV", "kW", "kvar", "phases"]
 VALID_SOURCE_PARAMS = ["kV", "phases", "frequency", "R0", "R1", "X0", "X1"]
-VALID_LINE_TRANSFORMER_PARAMS = ["length", "XHL", "Conns"]
+VALID_LINE_TRANSFORMER_PARAMS = ["length", "XHL", "Conns"]
+VALID_PV_PARAMS = ["kV", "phases"]
+VALID_GENERATOR_PARAMS = ["kV", "kW", "phases"]

pygridsim/__pycache__/enums.cpython-312.pyc

@@ -14,4 +14,9 @@ class LineType(Enum):
 class LoadType(Enum):
     HOUSE = {"kV": defaults.HOUSE_KV, "kW": defaults.HOUSE_KW, "kvar": defaults.HOUSE_KVAR}
     COMMERCIAL = {"kV": defaults.COMMERCIAL_KV, "kW": defaults.COMMERCIAL_KW, "kvar": defaults.COMMERCIAL_KVAR}
-    INDUSTRIAL = {"kV": defaults.INDUSTRIAL_KV, "kW": defaults.INDUSTRIAL_KW, "kvar": defaults.INDUSTRIAL_KVAR}
+    INDUSTRIAL = {"kV": defaults.INDUSTRIAL_KV, "kW": defaults.INDUSTRIAL_KW, "kvar": defaults.INDUSTRIAL_KVAR}
+
+class GeneratorType(Enum):
+    SMALL = {"kV": defaults.SMALL_GEN_KV, "kW": defaults.SMALL_GEN_KW}
+    LARGE = {"kV": defaults.LARGE_GEN_KV, "kW": defaults.LARGE_GEN_KW}
+    INDUSTRIAL = {"kV": defaults.INDUSTRIAL_GEN_KV, "kW": defaults.INDUSTRIAL_GEN_KW}

pygridsim/__pycache__/lines.cpython-312.pyc

@@ -36,5 +36,9 @@ def make_line(src, dst, line_type, count, params = {}, transformer = True):
     transformer.XHL = get_param(params, "XHL", defaults.XHL) 
     transformer.Buses = [src, dst]
     transformer.Conns = get_param(params, "Conns", [defaults.PRIMARY_CONN, defaults.SECONDARY_CONN])
-    transformer.kVs = [altdss.Vsource[src].BasekV, altdss.Load[dst].kV] 
+    # TOOD: edit this for clarity
+    if src == "source":
+        transformer.kVs = [altdss.Vsource[src].BasekV, altdss.Load[dst].kV] 
+    else:
+        transformer.kVs = [altdss.Generator[src].kV, altdss.Load[dst].kV] 
     transformer.end_edit()

pygridsim/__pycache__/parameters.cpython-312.pyc

@@ -2,7 +2,7 @@
 Helper functions to parse the parameters used for loads and sources
 """
 from altdss import altdss
-from altdss import AltDSS, Transformer, Vsource, Load, LoadModel, LoadShape, PVSystem
+from altdss import AltDSS, Transformer, Vsource, Load, PVSystem, Generator
 import pygridsim.defaults as defaults
 import random
 
@@ -100,8 +100,30 @@ def make_pv(load_node, params, num_panels, count):
         num_panels: representation of how many solar panels this PVsystem includes
         count: how many pv already made, to not run into duplicates
     """
+    check_valid_params(params, defaults.VALID_PV_PARAMS)
     pv : PVSystem = altdss.PVSystem.new('pv' + str(count))
     pv.Bus1 = load_node
     pv.Phases = get_param(params, "phases", defaults.PHASES)
     pv.kV = get_param(params, "kV", random_param(defaults.SOLAR_PANEL_BASE_KV) * num_panels)
-    # todo: inverter capacity?
+    # todo: inverter capacity?
+    if (pv.kV) < 0:
+        raise ValueError("Cannot have negative voltage for PVsystem")
+
+def make_generator(params, gen_type, count):
+    """
+    Make a PV at the load node given, scaling kV by the number of solar panels
+
+    Args:
+        params: any customized parameters
+        gen_type: type of generator (small, large, industrial)
+        count: how many generators already made, to not run into duplicates
+    """
+    check_valid_params(params, defaults.VALID_GENERATOR_PARAMS)
+    generator : Generator = altdss.Generator.new('generator' + str(count))
+    generator.Bus1 = 'generator' + str(count)
+    generator.Phases = get_param(params, "phases", defaults.PHASES)
+    for attr in ["kV", "kW"]:
+        setattr(generator, attr, get_param(params, attr, random_param(gen_type.value[attr])))
+
+    if (generator.kV) < 0:
+        raise ValueError("Cannot have negative voltage in generatorsource")