ecopipeline 0.8.12__tar.gz → 0.9.1__tar.gz

{ecopipeline-0.8.12/src/ecopipeline.egg-info → ecopipeline-0.9.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecopipeline
-Version: 0.8.12
+Version: 0.9.1
 Summary: Contains functions for use in Ecotope Datapipelines
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU General Public License (GPL)

{ecopipeline-0.8.12 → ecopipeline-0.9.1}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = ecopipeline
-version = 0.8.12
+version = 0.9.1
 authors = ["Carlos Bello, <bellocarlos@seattleu.edu>, Emil Fahrig <fahrigemil@seattleu.edu>, Casey Mang <cmang@seattleu.edu>, Julian Harris <harrisjulian@seattleu.edu>, Roger Tram <rtram@seattleu.edu>, Nolan Price <nolan@ecotope.com>"]
 description = Contains functions for use in Ecotope Datapipelines
 long_description = file: README.md

ecopipeline-0.9.1/src/ecopipeline/event_tracking/__init__.py

@@ -0,0 +1,2 @@
+from .event_tracking import *
+__all__ = ['flag_boundary_alarms','power_ratio_alarm']

{ecopipeline-0.8.12 → ecopipeline-0.9.1}/src/ecopipeline/event_tracking/event_tracking.py

@@ -77,6 +77,10 @@ def flag_boundary_alarms(df: pd.DataFrame, config : ConfigManager, default_fault
                     print(f"Could not process alarm for {bound_var}. Fault time must be greater than or equal to 1 minute.")
                 _check_and_add_alarm(df, lower_mask, alarms, day, bounds["fault_time"], bound_var, bounds['pretty_name'], 'Lower')
                 _check_and_add_alarm(df, upper_mask, alarms, day, bounds["fault_time"], bound_var, bounds['pretty_name'], 'Upper')
+
+    return _convert_silent_alarm_dict_to_df(alarms)
+
+def _convert_silent_alarm_dict_to_df(alarm_dict : dict) -> pd.DataFrame:
     events = {
         'start_time_pt' : [],
         'end_time_pt' : [],
@@ -84,7 +88,7 @@ def flag_boundary_alarms(df: pd.DataFrame, config : ConfigManager, default_fault
         'event_detail' : [],
         'variable_name' : []
     }
-    for key, value_list in alarms.items():
+    for key, value_list in alarm_dict.items():
         for value in value_list:
             events['start_time_pt'].append(key)
             events['end_time_pt'].append(key)
@@ -124,6 +128,68 @@ def _check_and_add_alarm(df : pd.DataFrame, mask : pd.Series, alarms_dict, day,
         else:
             alarms_dict[day] = [[var_name, alarm_string]]
 
+def power_ratio_alarm(daily_df: pd.DataFrame, config : ConfigManager, system: str = "") -> pd.DataFrame:
+    daily_df_copy = daily_df.copy()
+    variable_names_path = config.get_var_names_path()
+    try:
+        ratios_df = pd.read_csv(variable_names_path)
+    except FileNotFoundError:
+        print("File Not Found: ", variable_names_path)
+        return pd.DataFrame()
+    if (system != ""):
+        if not 'system' in ratios_df.columns:
+            raise Exception("system parameter is non null, however, system is not present in Variable_Names.csv")
+        ratios_df = ratios_df.loc[ratios_df['system'] == system]
+    required_columns = ["variable_name", "alarm_codes"]
+    for required_column in required_columns:
+        if not required_column in ratios_df.columns:
+            raise Exception(f"{required_column} is not present in Variable_Names.csv")
+    if not 'pretty_name' in ratios_df.columns:
+        ratios_df['pretty_name'] = ratios_df['variable_name']
+    ratios_df = ratios_df.loc[:, ["variable_name", "alarm_codes", "pretty_name"]]
+    ratios_df = ratios_df[ratios_df['alarm_codes'].str.contains('PR', na=False)]
+    ratios_df.dropna(axis=0, thresh=2, inplace=True)
+    ratios_df.set_index(['variable_name'], inplace=True)
+
+    ratio_dict = {}
+    for ratios_var, ratios in ratios_df.iterrows():
+        if not ratios_var in daily_df_copy.columns:
+                daily_df_copy[ratios_var] = 0
+        alarm_codes = str(ratios['alarm_codes']).split(";")
+        for alarm_code in alarm_codes:
+            if alarm_code[:2] == "PR":
+                split_out_alarm = alarm_code.split(":")
+                low_high = split_out_alarm[1].split("-")
+                pr_id = split_out_alarm[0].split("_")[1]
+                if len(low_high) != 2:
+                    raise Exception(f"Error processing alarm code {alarm_code}")
+                if pr_id in ratio_dict:
+                    ratio_dict[pr_id][0].append(ratios_var)
+                    ratio_dict[pr_id][1].append(float(low_high[0]))
+                    ratio_dict[pr_id][2].append(float(low_high[1]))
+                    ratio_dict[pr_id][3].append(ratios['pretty_name'])
+                else:
+                    ratio_dict[pr_id] = [[ratios_var],[float(low_high[0])],[float(low_high[1])],[ratios['pretty_name']]]
+
+    alarms = {}
+    for key, value_list in ratio_dict.items():
+        daily_df_copy[key] = daily_df_copy[value_list[0]].sum(axis=1)
+        for i in range(len(value_list[0])):
+            column_name = value_list[0][i]
+            daily_df_copy[f'{column_name}_{key}'] = (daily_df_copy[column_name]/daily_df_copy[key]) * 100
+            _check_and_add_ratio_alarm(daily_df_copy, key, column_name, value_list[3][i], alarms, value_list[2][i], value_list[1][i])
+    return _convert_silent_alarm_dict_to_df(alarms)      
+
+def _check_and_add_ratio_alarm(daily_df: pd.DataFrame, alarm_key : str, column_name : str, pretty_name : str, alarms_dict : dict, high_bound : float, low_bound : float):
+    alarm_daily_df = daily_df.loc[(daily_df[f"{column_name}_{alarm_key}"] < low_bound) | (daily_df[f"{column_name}_{alarm_key}"] > high_bound)]
+    if not alarm_daily_df.empty:
+        for day, values in alarm_daily_df.iterrows():
+            alarm_str = f"Power ratio alarm: {pretty_name} accounted for {round(values[f'{column_name}_{alarm_key}'], 2)}% of {alarm_key} energy use. {round(low_bound, 2)}-{round(high_bound, 2)}% of {alarm_key} energy use expected."
+            if day in alarms_dict:
+                alarms_dict[day].append([column_name, alarm_str])
+            else:
+                alarms_dict[day] = [[column_name, alarm_str]]
+
 # def flag_dhw_outage(df: pd.DataFrame, daily_df : pd.DataFrame, dhw_outlet_column : str, supply_temp : int = 110, consecutive_minutes : int = 15) -> pd.DataFrame:
 #     """
 #      Parameters

{ecopipeline-0.8.12 → ecopipeline-0.9.1}/src/ecopipeline/transform/__init__.py

@@ -1,7 +1,7 @@
 from .transform import rename_sensors, avg_duplicate_times, remove_outliers, ffill_missing, nullify_erroneous, sensor_adjustment, round_time, \
     aggregate_df, join_to_hourly, concat_last_row, join_to_daily, cop_method_1, cop_method_2, create_summary_tables, remove_partial_days, \
     convert_c_to_f,convert_l_to_g, convert_on_off_col_to_bool, flag_dhw_outage,generate_event_log_df,convert_time_zone, shift_accumulative_columns, \
-    heat_output_calc, add_relative_humidity, apply_equipment_cop_derate, create_data_statistics_df, delete_erroneous_from_time_pt
+    heat_output_calc, add_relative_humidity, apply_equipment_cop_derate, create_data_statistics_df, delete_erroneous_from_time_pt,column_name_change
 from .lbnl import nclarity_filter_new, site_specific, condensate_calculations, gas_valve_diff, gather_outdoor_conditions, aqsuite_prep_time, \
     nclarity_csv_to_df, _add_date, add_local_time, aqsuite_filter_new, get_refrig_charge, elev_correction, change_ID_to_HVAC, get_hvac_state, \
     get_cop_values, get_cfm_values, replace_humidity, create_fan_curves, lbnl_temperature_conversions, lbnl_pressure_conversions, \
@@ -13,4 +13,4 @@ __all__ = ["rename_sensors", "avg_duplicate_times", "remove_outliers", "ffill_mi
            "create_fan_curves", "lbnl_temperature_conversions", "lbnl_pressure_conversions", "lbnl_sat_calculations", "get_site_cfm_info", "get_site_info", "merge_indexlike_rows", "calculate_cop_values", "aggregate_values", 
            "get_energy_by_min", "verify_power_energy", "get_temp_zones120", "get_storage_gals120","convert_c_to_f","convert_l_to_g", "convert_on_off_col_to_bool", "flag_dhw_outage","generate_event_log_df","convert_time_zone",
            "shift_accumulative_columns","heat_output_calc", "add_relative_humidity","apply_equipment_cop_derate","create_data_statistics_df",
-           "delete_erroneous_from_time_pt"]
+           "delete_erroneous_from_time_pt","column_name_change"]

{ecopipeline-0.8.12 → ecopipeline-0.9.1}/src/ecopipeline/transform/transform.py

@@ -378,6 +378,31 @@ def nullify_erroneous(original_df: pd.DataFrame, config : ConfigManager) -> pd.D
 
     return df
 
+def column_name_change(df : pd.DataFrame, dt : pd.Timestamp, new_column : str, old_column : str, remove_old_column : bool = True) -> pd.DataFrame:
+    """
+    Overwrites values in `new_column` with values from `old_column` 
+    for all rows before `dt`, if `dt` is within the index range.
+
+    Parameters
+    ----------
+    df: pd.DataFrame
+        Pandas dataframe with minute-to-minute data
+    dt: pd.Timestamp
+        timestamp of the varriable name change
+    new_column: str
+        column to be overwritten
+    old_column: str
+        column to copy from
+    remove_old_column : bool
+        remove old column when done
+    """
+    if df.index.min() < dt:
+        mask = df.index < dt
+        df.loc[mask, new_column] = df.loc[mask, old_column]
+    if remove_old_column:
+        df = df.drop(columns=[old_column])
+    return df
+
 def heat_output_calc(df: pd.DataFrame, flow_var : str, hot_temp : str, cold_temp : str, heat_out_col_name : str, return_as_kw : bool = True) -> pd.DataFrame:
     """
     Function will take a flow varriable and two temperature inputs to calculate heat output 
@@ -903,7 +928,8 @@ def shift_accumulative_columns(df : pd.DataFrame, column_names : list = []):
     if len(column_names) == 0:
         return df_diff
     for column_name in column_names:
-        df[column_name] = df_diff[column_name]
+        if column_name in df.columns:
+            df[column_name] = df_diff[column_name]
     return df
 
 def create_summary_tables(df: pd.DataFrame):

{ecopipeline-0.8.12 → ecopipeline-0.9.1/src/ecopipeline.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ecopipeline
-Version: 0.8.12
+Version: 0.9.1
 Summary: Contains functions for use in Ecotope Datapipelines
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: GNU General Public License (GPL)

ecopipeline-0.8.12/src/ecopipeline/event_tracking/__init__.py

@@ -1,2 +0,0 @@
-from .event_tracking import *
-__all__ = ['flag_boundary_alarms']