change source enum, add config file for cleaner code and string inputs

Author: amzhao16

pygridsim/__pycache__/configs.cpython-312.pyc

@@ -0,0 +1,68 @@
+from pygridsim.enums import *
+from pygridsim.defaults import *
+
+LOAD_CONFIGURATIONS = {
+    LoadType.HOUSE: {
+        "kV": HOUSE_KV, 
+        "kW": HOUSE_KW, 
+        "kvar": HOUSE_KVAR
+    },
+    LoadType.COMMERCIAL: {
+        "kV": COMMERCIAL_KV,
+        "kW": COMMERCIAL_KW, 
+        "kvar": COMMERCIAL_KVAR
+    },
+    LoadType.INDUSTRIAL: {
+        "kV": INDUSTRIAL_KV, 
+        "kW": INDUSTRIAL_KW, 
+        "kvar": INDUSTRIAL_KVAR
+    }
+}
+
+SOURCE_CONFIGURATIONS = {
+    SourceType.TURBINE: {
+        "kV": TURBINE_BASE_KV
+    },
+    SourceType.POWER_PLANT: {
+        "kV": POWER_PLANT_KV
+    },
+    SourceType.LV_SUBSTATION: {
+        "kV": LV_SUBSTATION_BASE_KV
+    },
+    SourceType.MV_SUBSTATION: {
+        "kV": MV_SUBSTATION_BASE_KV
+    },
+    SourceType.HV_SUBSTATION: {
+        "kV": HV_SUBSTATION_BASE_KV
+    },
+    SourceType.SHV_SUBSTATION: {
+        "kV": SHV_SUBSTATION_BASE_KV
+    },
+}
+
+LINE_CONFIGURATIONS = {
+    LineType.LV_LINE: {
+        "length": LV_LINE_LENGTH
+    },
+    LineType.MV_LINE: {
+        "length": MV_LINE_LENGTH
+    },
+    LineType.HV_LINE: {
+        "length": HV_LINE_LENGTH
+    }
+}
+
+GENERATOR_CONFIGURATIONS = {
+    GeneratorType.SMALL: {
+        "kV": SMALL_GEN_KV, 
+        "kW": SMALL_GEN_KW, 
+    },
+    GeneratorType.LARGE: {
+        "kV": LARGE_GEN_KV, 
+        "kW": LARGE_GEN_KW, 
+    },
+    GeneratorType.INDUSTRIAL: {
+        "kV": INDUSTRIAL_GEN_KV, 
+        "kW": INDUSTRIAL_GEN_KW, 
+    }
+}

pygridsim/__pycache__/core.cpython-312.pyc

@@ -5,7 +5,6 @@
 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, GeneratorType
 
 """Main module."""
@@ -23,12 +22,13 @@ def __init__(self):
 		altdss.ClearAll()
 		altdss('new circuit.MyCircuit')
 
-	def add_load_nodes(self, params = {}, load_type: LoadType = LoadType.HOUSE, num = 1):
+	def add_load_nodes(self, params = {}, load_type: str = "house", num = 1):
 		"""
 		When the user wants to manually add nodes, or make nodes with varying parameters.
 
 		Args: 
 			params: load parameters for these manual additions
+			load_type: input as string, representing one of the load types
 			lines: which nodes these new loads are connected to
 			num (optional): number of loads to create with these parameters
 		Return:
@@ -40,13 +40,13 @@ def add_load_nodes(self, params = {}, load_type: LoadType = LoadType.HOUSE, num
 			self.num_loads += 1
 		return load_nodes
 
-	def update_source(self, params = {}, source_type: SourceType = SourceType.TURBINE):
+	def update_source(self, params = {}, source_type: str = "turbine"):
 		"""
 		Adds a main voltage source if it doesn't exist, otherwise edits it
 
 		Args:
 			params: load parameters for these manual additions
-			lines: which nodes these new sources are connected to
+			source_type: source type as a string
 			num (optional): number of sources to create with these parameters (removed for now)
 			(removed) num_in_batch: how many to batch together directly (so they can't be connected to lines separately, etc.
 				most common use case is if a house has 20 solar panels it's more useful to group them together)
@@ -92,13 +92,13 @@ def add_generator(self, num, params = {}, gen_type: GeneratorType = GeneratorTyp
 		return generators
 
 
-	def add_lines(self, connections, line_type: LineType = LineType.LV_LINE, params = {}, transformer = True):
+	def add_lines(self, connections, line_type: str = "lv", params = {}, transformer = True):
 		"""
 		Specify all lines that the user wants to add. If redundant lines, doesn't add anything
 
 		Args:
 			connections: a list of new connections to add. Each item of the list follows the form (source1, load1)
-			TODO: allow the input to also contain optional parameters
+			line_type: a string representing linetype if user wants to use preset parameters
 		"""
 		for src, dst in connections:
 			make_line(src, dst, line_type, self.num_lines, params, transformer)

pygridsim/__pycache__/defaults.cpython-312.pyc

@@ -1,23 +1,5 @@
 """
 Set any defaults (i.e. default source voltage, default node load etc.)
-Will start with things like HOUSE_KV to define typical load of a house (perhaps with some variance)
-
-Source:
-Define default values for a few types of objects.
-In a neighborhood the main ones are
-solar panels, wind turbines
-
-Load:
-Define for a typical house, using statistics
-https://forum.allaboutcircuits.com/threads/what-is-the-actual-household-voltage-110-115-120-220-240.3320/
-https://www.eia.gov/energyexplained/use-of-energy/electricity-use-in-homes.php?utm_source=chatgpt.com
-
-In the second iteration
-- implement the typical LoadShape in the house
-- some randomness to cover the standard distribution of houses, not all the averages
-
-For now, many of them are listed as tuples - lower end, higher end.
-TODO: make generate function that does Math.rand for in the range (later: improve distribution to be non-uniform)
 """
 from altdss import altdss
 from altdss import Connection
@@ -48,11 +30,15 @@
 """
 Source Nodes (including other form of sources, like PVSystem)
 """
-
-TURBINE_BASE_KV = [3000,4000]
-SOLAR_PANEL_BASE_KV = [0.2, 0.4] # per solar panel
 IMPEDANCE = 0.0001
+TURBINE_BASE_KV = [1,3]
+POWER_PLANT_KV = [10, 20]
+LV_SUBSTATION_BASE_KV = [0.2, 0.4]
+MV_SUBSTATION_BASE_KV = [6, 35]
+HV_SUBSTATION_BASE_KV = [66, 500]
+SHV_SUBSTATION_BASE_KV = [500, 1000]
 
+SOLAR_PANEL_BASE_KV = [0.2, 0.4] # per solar panel
 """
 Generator default values (small, large, industrial)
 """

pygridsim/__pycache__/enums.cpython-312.pyc

@@ -3,20 +3,24 @@
 
 # todo: update to have a name so that users can query from name
 class SourceType(Enum):
-    TURBINE = defaults.TURBINE_BASE_KV
-    SOLAR_PANEL = defaults.SOLAR_PANEL_BASE_KV
+    TURBINE = "turbine"
+    POWER_PLANT = "powerplant"
+    LV_SUBSTATION = "lvsub"
+    MV_SUBSTATION = "mvsub"
+    HV_SUBSTATION = "hvsub"
+    SHV_SUBSTATION = "shvsub"
 
 class LineType(Enum):
-    LV_LINE = defaults.LV_LINE_LENGTH
-    MV_LINE = defaults.MV_LINE_LENGTH
-    HV_LINE = defaults.HV_LINE_LENGTH
+    LV_LINE = "lv"
+    MV_LINE = "mv"
+    HV_LINE = "hv"
 
 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}
+    HOUSE = "house"
+    COMMERCIAL = "commercial"
+    INDUSTRIAL = "industrial"
 
 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}
+    SMALL = "small"
+    LARGE = "large"
+    INDUSTRIAL = "industrial"