change results and internally add name_to_nickname

Author: amzhao16

pygridsim/core.py

@@ -22,14 +22,16 @@ def __init__(self):
             num_transformers (int): Number of transformers in circuit so far.
             num_pv (int): Number of PV systems in circuit so far.
             num_generators (int): Number generators in circuit so far.
-            nickname_to_name (dict[str, str]): Map containing nicknames to their internal names.
+            nickname_to_name (dict[str, str]): Map from nicknames to their internal names.
+            name_to_nickname (dict[str, str]): Map from internal names to nicknames.
         """
         self.num_loads = 0
         self.num_lines = 0
         self.num_transformers = 0
         self.num_pv = 0
         self.num_generators = 0
         self.nickname_to_name = {}
+        self.name_to_nickname = {}
         altdss.ClearAll()
         altdss('new circuit.MyCircuit')
 
@@ -74,7 +76,9 @@ def add_load_nodes(self,
         for i in range(num):
             if (len(names) > i):
                 self._check_naming(names[i])
-                self.nickname_to_name[names[i]] = "load" + str(self.num_loads)
+                internal_name = "load" + str(self.num_loads)
+                self.nickname_to_name[names[i]] = internal_name
+                self.name_to_nickname[internal_name] = names[i]
 
             _make_load_node(params, load_type, self.num_loads)
             self.num_loads += 1
@@ -165,7 +169,9 @@ def add_generators(self,
         for i in range(num):
             if (len(names) > i):
                 self._check_naming(names[i])
-                self.nickname_to_name[names[i]] = "generator" + str(self.num_generators)
+                internal_name = "generator" + str(self.num_generators)
+                self.nickname_to_name[names[i]] = internal_name
+                self.name_to_nickname[internal_name] = names[i]
 
             generators.append(_make_generator(params, gen_type, count=self.num_generators))
             self.num_generators += 1
@@ -235,7 +241,7 @@ def results(self, queries: list[str], export_path=""):
         """
         results = {}
         for query in queries:
-            results[query] = _query_solution(query)
+            results[query] = _query_solution(query, self.name_to_nickname)
 
         if (export_path):
             _export_results(results, export_path)

pygridsim/results.py

@@ -7,12 +7,16 @@
 from altdss import altdss
 
 
-def _query_solution(query):
+def _query_solution(query, name_to_nickname):
     match query:
         case "Voltages":
             bus_vmags = {}
             for bus_name, bus_vmag in zip(altdss.BusNames(), altdss.BusVMag()):
-                bus_vmags[bus_name] = float(bus_vmag)
+                return_name = bus_name
+                if bus_name in name_to_nickname:
+                    nickname = name_to_nickname[bus_name]
+                    return_name += "/" + nickname
+                bus_vmags[return_name] = float(bus_vmag)
             return bus_vmags
         case "Losses":
             vector_losses = altdss.Losses()