refactor: create library of constants for grid object, casemat file a…

…nd pypsa translators (#667)
Breakthrough-Energy · Sep 9, 2022 · 46894c5 · 46894c5
1 parent 5d2ec5c
commit 46894c5
Show file tree

Hide file tree

Showing 9 changed files with 557 additions and 300 deletions.
diff --git a/powersimdata/input/abstract_grid.py b/powersimdata/input/abstract_grid.py
@@ -1,6 +1,6 @@
 import pandas as pd
 
-from powersimdata.input import const
+from powersimdata.input.const import grid_const
 
 
 class AbstractGrid:
@@ -12,13 +12,32 @@ def __init__(self):
         self.interconnect = None
         self.zone2id = {}
         self.id2zone = {}
-        self.sub = pd.DataFrame()
-        self.plant = pd.DataFrame()
-        self.gencost = {"before": pd.DataFrame(), "after": pd.DataFrame()}
-        self.dcline = pd.DataFrame()
-        self.bus2sub = pd.DataFrame()
-        self.bus = pd.DataFrame()
-        self.branch = pd.DataFrame()
+        self.sub = pd.DataFrame(columns=grid_const.col_name_sub).rename_axis(
+            grid_const.indices["sub"]
+        )
+        self.plant = pd.DataFrame(columns=grid_const.col_name_plant).rename_axis(
+            grid_const.indices["plant"]
+        )
+        self.gencost = {
+            "before": pd.DataFrame(columns=grid_const.col_name_gencost).rename_axis(
+                grid_const.indices["plant"]
+            ),
+            "after": pd.DataFrame(columns=grid_const.col_name_gencost).rename_axis(
+                grid_const.indices["plant"]
+            ),
+        }
+        self.dcline = pd.DataFrame(columns=grid_const.col_name_dcline).rename_axis(
+            grid_const.indices["dcline"]
+        )
+        self.bus2sub = pd.DataFrame(columns=grid_const.col_name_bus2sub).rename_axis(
+            grid_const.indices["bus2sub"]
+        )
+        self.bus = pd.DataFrame(columns=grid_const.col_name_bus).rename_axis(
+            grid_const.indices["bus"]
+        )
+        self.branch = pd.DataFrame(columns=grid_const.col_name_branch).rename_axis(
+            grid_const.indices["branch"]
+        )
         self.storage = storage_template()
         self.grid_model = ""
         self.model_immutables = None
@@ -30,9 +49,9 @@ def storage_template():
     :return: (*dict*) -- storage structure for MATPOWER/MOST
     """
     storage = {
-        "gen": pd.DataFrame(columns=const.col_name_plant),
-        "gencost": pd.DataFrame(columns=const.col_name_gencost),
-        "StorageData": pd.DataFrame(columns=const.col_name_storage_storagedata),
+        "gen": pd.DataFrame(columns=grid_const.col_name_plant),
+        "gencost": pd.DataFrame(columns=grid_const.col_name_gencost),
+        "StorageData": pd.DataFrame(columns=grid_const.col_name_storage_storagedata),
         "genfuel": [],
         "duration": None,  # hours
         "min_stor": None,  # ratio

diff --git a/powersimdata/input/const/__init__.py b/powersimdata/input/const/__init__.py
diff --git a/powersimdata/input/const.py → powersimdata/input/const/casemat_const.py b/powersimdata/input/const.py → powersimdata/input/const/casemat_const.py
diff --git a/powersimdata/input/const/grid_const.py b/powersimdata/input/const/grid_const.py
@@ -0,0 +1,315 @@
+# The index name of each data frame
+indices = {
+    "sub": "sub_id",
+    "bus2sub": "bus_id",
+    "branch": "branch_id",
+    "bus": "bus_id",
+    "dcline": "dcline_id",
+    "plant": "plant_id",
+}
+
+# AC lines
+col_name_branch = [
+    "from_bus_id",
+    "to_bus_id",
+    "r",
+    "x",
+    "b",
+    "rateA",
+    "rateB",
+    "rateC",
+    "ratio",
+    "angle",
+    "status",
+    "angmin",
+    "angmax",
+    "Pf",
+    "Qf",
+    "Pt",
+    "Qt",
+    "mu_Sf",
+    "mu_St",
+    "mu_angmin",
+    "mu_angmax",
+    "branch_device_type",
+    "interconnect",
+    "from_zone_id",
+    "to_zone_id",
+    "from_zone_name",
+    "to_zone_name",
+    "from_lat",
+    "from_lon",
+    "to_lat",
+    "to_lon",
+]
+col_type_branch = [
+    "int",
+    "int",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "int",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "str",
+    "str",
+    "int",
+    "int",
+    "str",
+    "str",
+    "float",
+    "float",
+    "float",
+    "float",
+]
+
+
+# bus
+col_name_bus = [
+    "type",
+    "Pd",
+    "Qd",
+    "Gs",
+    "Bs",
+    "zone_id",
+    "Vm",
+    "Va",
+    "baseKV",
+    "loss_zone",
+    "Vmax",
+    "Vmin",
+    "lam_P",
+    "lam_Q",
+    "mu_Vmax",
+    "mu_Vmin",
+    "interconnect",
+    "lat",
+    "lon",
+]
+col_type_bus = [
+    "int",
+    "float",
+    "float",
+    "float",
+    "float",
+    "int",
+    "float",
+    "float",
+    "float",
+    "int",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "str",
+    "float",
+    "float",
+]
+
+
+# bus to substations
+col_name_bus2sub = ["sub_id", "interconnect"]
+col_type_bus2sub = ["int", "str"]
+
+
+# DC lines
+col_name_dcline = [
+    "from_bus_id",
+    "to_bus_id",
+    "status",
+    "Pf",
+    "Pt",
+    "Qf",
+    "Qt",
+    "Vf",
+    "Vt",
+    "Pmin",
+    "Pmax",
+    "QminF",
+    "QmaxF",
+    "QminT",
+    "QmaxT",
+    "loss0",
+    "loss1",
+    "muPmin",
+    "muPmax",
+    "muQminF",
+    "muQmaxF",
+    "muQminT",
+    "muQmaxT",
+    "from_interconnect",
+    "to_interconnect",
+]
+col_type_dcline = [
+    "int",
+    "int",
+    "int",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "str",
+    "str",
+]
+
+
+# Generation Cost
+col_name_gencost = [
+    "type",
+    "startup",
+    "shutdown",
+    "n",
+    "c2",
+    "c1",
+    "c0",
+    "interconnect",
+]
+col_type_gencost = ["int", "float", "float", "int", "float", "float", "float", "str"]
+
+
+# Generator
+col_name_plant = [
+    "bus_id",
+    "Pg",
+    "Qg",
+    "Qmax",
+    "Qmin",
+    "Vg",
+    "mBase",
+    "status",
+    "Pmax",
+    "Pmin",
+    "Pc1",
+    "Pc2",
+    "Qc1min",
+    "Qc1max",
+    "Qc2min",
+    "Qc2max",
+    "ramp_agc",
+    "ramp_10",
+    "ramp_30",
+    "ramp_q",
+    "apf",
+    "mu_Pmax",
+    "mu_Pmin",
+    "mu_Qmax",
+    "mu_Qmin",
+    "type",
+    "interconnect",
+    "GenFuelCost",
+    "GenIOB",
+    "GenIOC",
+    "GenIOD",
+    "zone_id",
+    "zone_name",
+    "lat",
+    "lon",
+]
+col_type_plant = [
+    "int",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "int",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "str",
+    "str",
+    "float",
+    "float",
+    "float",
+    "int",
+    "int",
+    "str",
+    "float",
+    "float",
+]
+
+
+# substations
+col_name_sub = ["name", "interconnect_sub_id", "lat", "lon", "interconnect"]
+col_type_sub = ["str", "int", "float", "float", "str"]
+
+
+# storage
+col_name_storage_storagedata = [
+    "UnitIdx",
+    "InitialStorage",
+    "InitialStorageLowerBound",
+    "InitialStorageUpperBound",
+    "InitialStorageCost",
+    "TerminalStoragePrice",
+    "MinStorageLevel",
+    "MaxStorageLevel",
+    "OutEff",
+    "InEff",
+    "LossFactor",
+    "rho",
+    "ExpectedTerminalStorageMax",
+    "ExpectedTerminalStorageMin",
+]
+col_type_storage_storagedata = [
+    "int",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+    "float",
+]