import pandas as pd
from powersimdata.scenario.analyze import Analyze
from powersimdata.tests.mock_grid import MockGrid
def _ensure_ts_index(df):
"""If a dataframe is provided and the index is not a time series, add a time series
index. If the input is None, return it as is.
:param pandas.DataFrame/None df: data frame, or None.
:return: (*pandas.DataFrame/None*) -- input, with time series index if possible.
"""
if df is None:
return df
if not isinstance(df.index, pd.DatetimeIndex):
df.set_index(
pd.date_range(start="2016-01-01", periods=len(df), freq="H"),
inplace=True,
)
df.index.name = "UTC"
return df
[docs]class MockAnalyze:
"""A mock of a powersimdata.scenario.analyze.Analyze object.
:param dict grid_attrs: fields to be added to grid.
:param pandas.DataFrame congl: dummy congl
:param pandas.DataFrame congu: dummy congu
:param dict ct: dummy ct
:param pandas.DataFrame demand: dummy demand
:param pandas.DataFrame lmp: dummy lmp
:param pandas.DataFrame pf: dummy pf
:param pandas.DataFrame pg: dummy pg
:param pandas.DataFrame storage_pg: dummy storage_pg
:param pandas.DataFrame solar: dummy solar
:param pandas.DataFrame wind: dummy wind
:param pandas.DataFrame hydro: dummy hydro
"""
exported_methods = [
"get_congl",
"get_congu",
"get_ct",
"get_bus_demand",
"get_demand",
"get_grid",
"get_lmp",
"get_pf",
"gt_dcline_pf",
"get_pg",
"get_storage_pg",
"get_storage_e",
"get_solar",
"get_wind",
"get_hydro",
"get_profile",
]
def __init__(
self,
grid_attrs=None,
congl=None,
congu=None,
ct=None,
demand=None,
bus_demand=None,
lmp=None,
pf=None,
pg=None,
dcline_pf=None,
storage_e=None,
storage_pg=None,
solar=None,
wind=None,
hydro=None,
):
"""Constructor."""
self.grid = MockGrid(grid_attrs)
self.congl = _ensure_ts_index(congl)
self.congu = _ensure_ts_index(congu)
self.ct = ct if ct is not None else {}
self.demand = _ensure_ts_index(demand)
self.bus_demand = _ensure_ts_index(bus_demand)
self.lmp = _ensure_ts_index(lmp)
self.pf = _ensure_ts_index(pf)
self.dcline_pf = _ensure_ts_index(dcline_pf)
self.pg = _ensure_ts_index(pg)
self.storage_e = _ensure_ts_index(storage_e)
self.storage_pg = _ensure_ts_index(storage_pg)
self.solar = _ensure_ts_index(solar)
self.wind = _ensure_ts_index(wind)
self.hydro = _ensure_ts_index(hydro)
self.name = "analyze"
[docs] def get_congl(self):
"""Get congl.
:return: (pandas.DataFrame) -- dummy congl
"""
return self.congl
[docs] def get_congu(self):
"""Get congu.
:return: (pandas.DataFrame) -- dummy congu
"""
return self.congu
[docs] def get_ct(self):
"""Get ct.
:return: (Dict) -- dummy ct
"""
return self.ct
[docs] def get_demand(self, original=None):
"""Get demand.
:return: (pandas.DataFrame) -- dummy demand
"""
return self.demand
[docs] def get_bus_demand(self):
"""Get bus demand.
:return: (pandas.DataFrame) -- dummy bus demand
"""
return self.bus_demand
[docs] def get_grid(self):
"""Get grid.
:return: (MockGrid) -- mock grid
"""
return self.grid
[docs] def get_lmp(self):
"""Get lmp.
:return: (pandas.DataFrame) -- dummy lmp
"""
return self.lmp
[docs] def get_pf(self):
"""Get PF.
:return: (pandas.DataFrame) -- dummy pf
"""
return self.pf
[docs] def get_dcline_pf(self):
"""Get PF_DCLINE.
:return: (pandas.DataFrame) -- dummy pf_dcline
"""
return self.dcline_pf
[docs] def get_pg(self):
"""Get PG.
:return: (pandas.DataFrame) -- dummy pg
"""
return self.pg
[docs] def get_storage_e(self):
"""Get storage E.
:return: (pandas.DataFrame) -- dummy storage_e
"""
return self.storage_e
[docs] def get_storage_pg(self):
"""Get storage PG.
:return: (pandas.DataFrame) -- dummy storage_pg
"""
return self.storage_pg
[docs] def get_solar(self):
"""Get solar.
:return: (pandas.DataFrame) -- dummy solar
"""
return self.solar
[docs] def get_wind(self):
"""Get wind.
:return: (pandas.DataFrame) -- dummy wind
"""
return self.wind
[docs] def get_hydro(self):
"""Get hydro.
:return: (pandas.DataFrame) -- dummy hydro
"""
return self.hydro
[docs] def get_profile(self, kind):
"""Return profile
:param str kind: either *'demand'*, *'hydro'*, *'solar'*, *'wind'*.
:return: (*pandas.DataFrame*) -- dummy profile.
:raises ValueError: if kind is invalid.
"""
if kind == "demand":
return self.demand
elif kind == "hydro":
return self.hydro
elif kind == "solar":
return self.solar
elif kind == "wind":
return self.wind
else:
raise ValueError("kind must be one of demand | hydro | solar | wind")
@property
def __class__(self):
"""If anyone asks, I'm an Analyze object!"""
return Analyze
