energy-reports-pkg 0.6.14__py3-none-any.whl

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/preprocessing_for_piechart/transform_asset_stats_for_adaptive_piechart/get_sum_for_curr_and_prev/__init__.py

@@ -0,0 +1,20 @@
+
+
+def get_sum_for_curr_and_prev(df_pivot_asset_group_by_period):
+
+    # get the exact values of current period and period to be compared
+    period_range = df_pivot_asset_group_by_period.columns
+    period_current = period_range[-1]
+
+    # for avoiding the case that we don't have data for the previous week
+    if len(period_range) < 2:
+        period_tobe_compared = period_range[-1]
+    else:
+        period_tobe_compared = period_range[-2]
+        
+    # get the total of current period and previous period, and the difference between the two periods
+    df_pivot_asset_group_by_period_renamed = df_pivot_asset_group_by_period.loc[:,period_current].to_frame().rename(columns={period_current: "sum"})
+    df_pivot_asset_group_by_period_renamed["sum_pre"] = df_pivot_asset_group_by_period.loc[:,period_tobe_compared]
+    df_pivot_asset_group_by_period_renamed['sub'] = df_pivot_asset_group_by_period.loc[:,period_current] - df_pivot_asset_group_by_period.loc[:,period_tobe_compared]
+
+    return df_pivot_asset_group_by_period_renamed

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_report/PDF/__init__.py

@@ -0,0 +1,44 @@
+from fpdf import FPDF
+from PIL import ImageColor
+import os
+
+import colorsys
+
+from mdl.utils_ import color_dict
+
+cd = color_dict
+
+assets_folder = os.path.join(os.path.dirname(__file__), '_assets_/')
+
+class PDF(FPDF):
+
+    # def __init__(self, asset_folder):
+    #     FPDF.__init__(self)
+    #     self.assets_folder = assets_folder
+
+    def header(self):
+        #Logo
+        self.image(assets_folder+'LetterHead - header - Mindsett_weekly.png', 0, 0, self.w)
+        #Fontsize and type
+        self.set_font('Arial', 'B', 15)
+        self.image(assets_folder+"2024_Mindsett_Logo_White.png", 10, 8, 60)
+        # self.image(assets_folder+"mindsett_logo_white_transparent.png", 15, 15, 45)
+        
+    def footer(self):
+        #Logo
+        footer_height = 32
+        img_path = assets_folder+'LetterHead - Footer - Mindsett_weekly.png'
+        footer_width = 210
+        self.image(img_path, 0, self.h-footer_height, footer_width)
+        self.set_font('Arial', 'B', 15)
+        
+        self.set_y(self.h-footer_height + 5)
+        self.set_x(20)
+        self.set_font('Arial', "I", 8)
+        color_rgb = ImageColor.getcolor(cd["Mindsett Blue"], "RGB")
+        color_hsv = colorsys.rgb_to_hsv(*color_rgb)
+        color_rgb_changed = colorsys.hsv_to_rgb(color_hsv[0], color_hsv[1], color_hsv[2])
+        self.set_text_color(*color_rgb_changed)
+        #self.cell(pdf.w - 30, 10, '**BBP benchmarking (REEB) ', 0, 0, 'B')
+        
+    from .write_multicell_with_styles import write_multicell_with_styles

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_report/PDF/write_multicell_with_styles.py

@@ -0,0 +1,30 @@
+
+
+def write_multicell_with_styles(self, max_width, cell_height, text_list):
+
+        # Source:https://stackoverflow.com/questions/60736940/how-to-make-inline-bold-text-using-pyfpdf#
+        startx = self.get_x()
+        self.set_font('Arial', '', 12)
+
+        #loop through differenct sections in different styles
+        for text_part in text_list:
+            #check and set style
+            try:
+                current_style = text_part['style']
+                self.set_font('Arial', current_style, 12)
+            except KeyError:
+                self.set_font('Arial', '', 12)
+
+            #loop through words and write them down
+            space_width = self.get_string_width(' ')
+            for word in text_part['text'].split(' '):
+                current_pos = self.get_x()
+                word_width = self.get_string_width(word)
+                #check for newline
+                if (current_pos + word_width) > (startx + max_width):
+                    #return 
+                    self.set_y(self.get_y() + cell_height)
+                    self.set_x(startx)
+                self.cell(word_width, 5, word)
+                #add a space
+                self.set_x(self.get_x() + space_width)

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_report/__init__.py

@@ -0,0 +1,162 @@
+import pickle
+from PIL import ImageColor
+import os
+import io
+
+import colorsys
+
+from mdl.utils_ import color_dict
+from .PDF import PDF
+
+cd = color_dict
+        
+def generate_report(site_name, period, 
+                    statements_list=None, 
+                    organisation=None, 
+                    components=None,
+                    files_folder=None, 
+                    figures_folder=None, 
+                    report_file_folder=None,
+                    assets_folder=None):
+    
+    if assets_folder == None:
+        assets_folder = os.path.join(os.path.dirname(__file__), '_assets_/')
+
+    pdf = PDF()
+    pdf.add_page()
+
+    pdf.image(assets_folder+'Screenshot_by_date_weekly.png', 0.3, 70, 8)
+    pdf.image(assets_folder+'Screenshot_by_asset_weekly.png', 0.3, 70+65, 8)
+    pdf.image(assets_folder+'Screenshot_insights_weekly.png', 0.3, 70+130, 8)
+    pdf.set_font('Arial', "B", 28)
+    # Line break
+    pdf.ln(19)
+
+    color_rgb = ImageColor.getcolor(cd["Mindsett Blue"], "RGB")
+    color_hsv = colorsys.rgb_to_hsv(*color_rgb)
+    color_rgb_changed = colorsys.hsv_to_rgb(color_hsv[0], color_hsv[1]*1.2, color_hsv[2]*0.85)
+    pdf.set_text_color(*color_rgb_changed)
+
+    pdf.cell(pdf.w - 28, 10, 'Energy Consumption', 0, 0, 'R')
+    pdf.set_font('Arial', "I", 16)
+    # Line break
+    pdf.ln(13)
+
+    color_rgb = ImageColor.getcolor(cd["darkgrey"], "RGB")
+    color_hsv = colorsys.rgb_to_hsv(*color_rgb)
+    color_rgb_changed = colorsys.hsv_to_rgb(color_hsv[0], color_hsv[1], color_hsv[2])
+    pdf.set_text_color(*color_rgb_changed)
+
+    # generate period name
+    
+    if period.freqstr == "M":
+    
+        period_str = period.strftime('%b %Y')
+    else:
+        # add 1 week to the current_period_obj so that the start week is not Week 00
+        period_week_str = period.strftime('%W')
+        period_year_str = period.strftime('%Y')
+        period_str = f'Wk {(int(period_week_str)+1):02d}, {period_year_str}'
+    
+    REPLACEMENTS = {"""''""": """'""",
+                    "Mecca Bingo": "MB",
+                    "Grosvenor": "GC",
+                    # "The Rank Group": "Rank",
+                    "Marina Bay Financial Center, Tower 2": "MBFC T2"}
+
+    for item in REPLACEMENTS:
+        site_name = site_name.replace(item, REPLACEMENTS[item])
+
+    site_name_update = site_name
+    sub_title_name = f'{site_name_update} - {period_str} '
+    
+    if organisation is not None:
+        for item in REPLACEMENTS:
+            organisation = organisation.replace(item, REPLACEMENTS[item])
+        organisation_update = organisation
+        sub_title_name = f'{organisation_update} - {sub_title_name}'
+
+    report_file_name = 'Mindsett_Energy_Report_' + sub_title_name.strip().replace(" - ", "_").replace(" ", "_").replace(",", "") + '.pdf'
+
+    pdf.cell(pdf.w - 27, 10, sub_title_name, 0, 0, 'R')
+
+    # if components != None:
+
+    consumption_by_assetclass_piechart_with_phase = components['consumption_by_assetclass_piechart_with_phase.png']
+    period_barchart = components['period_barchart.png']
+    monthly_total_and_bm_latest = components['monthly_total_and_bm_latest.png']
+    daily_barchart_with_temp = components['daily_barchart_with_temp.png']
+    auto_statements_list_or_path = components['statements.pkl']
+
+    if isinstance(auto_statements_list_or_path, str):
+        with open(auto_statements_list_or_path, 'rb') as f:
+            auto_statements_list = pickle.load(f)
+    else:
+        auto_statements_list = auto_statements_list_or_path
+    # else:
+    #     consumption_by_assetclass_piechart_mindsett = figures_folder+'consumption_by_assetclass_piechart_mindsett.png'
+    #     total_consumption_barchart_with_co2 = figures_folder+'total_consumption_barchart_with_co2.png'
+    #     monthly_total_and_bm_latest = figures_folder+'monthly_total_and_bm_latest.png'
+    #     daily_consumption_barchart_with_occupancy_mar_with_pattern_mwh = figures_folder+'daily_consumption_barchart_with_occupancy_mar_with_pattern_mwh.png'
+
+    #     with open(files_folder+'statements.pkl', 'rb') as f:
+    #         auto_statements_list = pickle.load(f)
+
+    pdf.image(consumption_by_assetclass_piechart_with_phase, 14 + 0.2, 55+69+4, 144)
+    pdf.image(period_barchart, 136, 55+82-1, 60)
+    pdf.image(monthly_total_and_bm_latest, 14.5, 48+9+3.5, 65-7) # here 3.5 is added to make space for the subtitle
+
+    pdf.ln(151) #Contol on paragraphs 
+    pdf.set_x(29)
+    pdf.image(daily_barchart_with_temp, 71, 62+3.5, 135) # here 3.5 is added to make space for the subtitle
+
+    # Insights statements 
+
+    if statements_list is not None:
+
+        insight_statements_list = statements_list
+
+        pdf.ln(5)
+        pdf.set_x(20)
+        pdf.set_font('Arial', 'I', 12)
+        pdf.set_text_color(0,0,0)
+        pdf.multi_cell(pdf.w - 50, 10, 'Insights: \n')
+
+        text_list = []
+
+        for statement in insight_statements_list:
+
+            statement_text =  [{'text': '- '+statement+' '}]
+            text_list += statement_text
+
+        pdf.set_x(29)
+        pdf.write_multicell_with_styles(pdf.w-50,6,text_list)
+
+    # Automated Observations statements
+    pdf.ln(5)
+    pdf.set_x(20)
+    pdf.set_font('Arial', 'I', 12)
+    pdf.set_text_color(0,0,0)
+    pdf.multi_cell(pdf.w - 50, 10, 'Automated Observations: \n')
+
+    text_list = []
+
+    for statement in auto_statements_list:
+
+        statement_text =  [{'text': '- '+statement+' '}]
+        text_list += statement_text
+
+    pdf.set_x(29)
+    pdf.write_multicell_with_styles(pdf.w-50,6,text_list) #6
+
+
+    if report_file_folder == None:
+        
+        pdf_object = io.BytesIO()
+        pdf.output(pdf_object, 'F')
+        return {report_file_name: pdf_object}
+    else:
+
+        report_file_dir = report_file_folder + report_file_name
+        pdf.output(report_file_dir, 'F')
+        return {report_file_name: report_file_dir}

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/preparing_source_data/__init__.py

@@ -0,0 +1,78 @@
+# from pathlib import Path
+from os import path
+import pandas as pd
+from cache_return import cache_return
+
+from mdl.utils_ import enriching_time_features
+from mdl.utils_ import patch_missing_periods
+
+# from .unify_db_interface import unify_db_interface
+from .load_source_data import load_source_data
+
+from .validate_data_not_empty import validate_data_not_empty
+from .refine_group_name import refine_group_name
+# from .patch_missing_periods import patch_missing_periods
+
+@cache_return
+def preparing_source_data(postgresdb, 
+                          site_obj,
+                          debug=False,
+                          chunksize=10):
+    
+    # get the specific time for the individual site
+    start_time = site_obj.get_start_time()
+    start_time_co2_barchart = site_obj.get_start_time_co2_barchart()
+    end_time = site_obj.get_end_time()
+    schedule_records = site_obj.get_schedule_records(postgresdb)
+
+    df_meta_with_value, df_meta_with_value_building = load_source_data(postgresdb, 
+                                                                        start_time, 
+                                                                        start_time_co2_barchart,
+                                                                        end_time, 
+                                                                        site_obj.building_id,
+                                                                        chunksize=chunksize,
+                                                                        exception=site_obj.exception,
+                                                                        timezone=site_obj.timezone,
+                                                                        caching=debug)
+    
+    # print('df_meta_with_value.shape: ', df_meta_with_value.shape)
+    validate_data_not_empty(df_meta_with_value, df_meta_with_value_building)
+
+    # print('df_meta_with_value.info: ', df_meta_with_value.info())
+
+    df_meta_with_value = patch_missing_periods(df_meta_with_value, start_time, end_time,
+                                                        time_col='time',
+                                                        value_col='W',
+                                                        period_freq=site_obj.period_freq,
+                                                        timezone=site_obj.timezone)
+
+    df_meta_with_value_building = patch_missing_periods(df_meta_with_value_building, start_time_co2_barchart, end_time,
+                                                        time_col='time',
+                                                        value_col='kwh',
+                                                        period_freq=site_obj.period_freq,
+                                                        timezone=site_obj.timezone)
+    
+    df_meta_with_value = refine_group_name(df_meta_with_value, 
+                                           site_obj.asset_group, 
+                                           site_obj.group_name_column_exchange, 
+                                           site_obj.fillna_value,
+                                           site_obj.group_name_modification)
+
+    df_meta_with_value = enriching_time_features(df_meta_with_value, 
+                                                    schedule_records= schedule_records,
+                                                    period_freq=site_obj.period_freq,
+                                                    weekend=site_obj.weekend, 
+                                                    working_end_time=site_obj.working_end_time, 
+                                                    working_start_time=site_obj.working_start_time,
+                                                    timezone=site_obj.timezone)
+
+    df_meta_with_value_building = enriching_time_features(df_meta_with_value_building,
+                                                    schedule_records= schedule_records,
+                                                    period_freq=site_obj.period_freq,
+                                                    weekend=site_obj.weekend, 
+                                                    working_end_time=site_obj.working_end_time, 
+                                                    working_start_time=site_obj.working_start_time,
+                                                    timezone=site_obj.timezone)
+    
+    # print('df_meta_with_value.shape: ', df_meta_with_value.shape)
+    return df_meta_with_value, df_meta_with_value_building

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/preparing_source_data/load_source_data/__init__.py

@@ -0,0 +1,32 @@
+from os import path
+import pandas as pd
+
+from .query_building_total import query_building_total
+from .import_data_with_meta_postgres import import_data_with_meta_postgres
+
+from cache_return import cache_return
+
+@cache_return
+def load_source_data(postgresdb, 
+                     start_time, 
+                     start_time_co2_barchart,
+                     end_time, 
+                     building_id,
+                     exception=None,
+                     chunksize=10,
+                     timezone='UTC'):
+
+    df_meta_with_value = import_data_with_meta_postgres(postgresdb, 
+                                                            start_time, 
+                                                            end_time, 
+                                                            building_id,
+                                                            exception=exception,
+                                                            chunksize=chunksize,
+                                                            timezone=timezone)
+    df_meta_with_value_building = query_building_total(postgresdb, 
+                                                        start_time=start_time_co2_barchart,
+                                                        end_time=end_time, 
+                                                        building_id=building_id, # please note that this is a postition arg
+                                                        timezone=timezone)
+    
+    return df_meta_with_value, df_meta_with_value_building

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/preparing_source_data/load_source_data/import_data_with_meta_postgres/__init__.py

@@ -0,0 +1,47 @@
+import pandas as pd
+
+from .load_metadata import load_metadata
+from .load_iot_data import load_iot_data
+
+def import_data_with_meta_postgres(db, start_time, end_time, building_id, 
+                        #   organisation=None, 
+                          exception=None,
+                          chunksize=10,
+                          # meta_columns_for_join=['nid', 'channel_number'],
+                          # iot_columns_for_join=['nid', 'channel'],
+                          # reading_interval_in_mins=10,
+                          timezone='UTC'):  # the resampling operation should be implemented later
+
+    # format the time range
+    query_start_time = pd.Timestamp(start_time, tz=timezone)
+    query_end_time  =  pd.Timestamp(end_time, tz=timezone)
+
+    query_start_time_str = query_start_time.strftime("%Y-%m-%d %H:%M:%S.%f%z")
+    query_end_time_str   = query_end_time.strftime("%Y-%m-%d %H:%M:%S.%f%z")
+
+    time_range = [query_start_time_str, query_end_time_str]
+
+    engine = db.engine
+    table_name_iot = db.table_iot.name
+    table_name_meta = db.table_meta.name
+    # table_name_link = db.table_name_link
+
+    df_meta = load_metadata(engine, table_name_meta, building_id, 
+                            # organisation=organisation,
+                            exception=exception)
+
+    if df_meta.shape[0] == 0:
+
+        raise Exception('There is not metadata found for this building!')
+
+    # print('df_meta: ', df_meta)
+
+    id_list = df_meta.id.to_list()
+
+    df_emd = load_iot_data(engine, time_range, table_name_iot, id_list, chunksize=chunksize)
+
+    df_meta_with_value = df_emd.merge(df_meta, on='id').drop(columns=['id']).rename(columns={'w': 'W'})
+
+    # print('df_meta_with_value.shape: ', df_meta_with_value.shape)
+
+    return df_meta_with_value

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/preparing_source_data/load_source_data/import_data_with_meta_postgres/load_iot_data/__init__.py

@@ -0,0 +1,28 @@
+
+import pandas as pd
+from tqdm import tqdm
+
+from .load_iot_data_partition import load_iot_data_partition
+
+def load_iot_data(engine, time_range, iot_table_name, id_list, chunksize=10):
+
+    # time_partition_list = generate_time_partition_list(time_range, freq=partition_freq)
+
+    df_iot = pd.DataFrame([])
+
+    id_list_partitions = [id_list[x:x+chunksize] for x in range(0, len(id_list), chunksize)]
+
+    no_partition = len(id_list_partitions)
+
+    # for id_list_part in tqdm(id_list_partitions):
+    for batch, id_list_part in enumerate(id_list_partitions):
+
+        print(f'batch: {batch+1}/{no_partition}')
+        df_iot_part = load_iot_data_partition(engine, time_range, iot_table_name, id_list_part)
+        # df_iot_part = load_iot_data_partition(engine, time_partition, iot_table_name, meta_table_name, statement_full)
+
+        df_iot = pd.concat([df_iot, df_iot_part])
+        
+    return df_iot
+
+    # load_iot_data_partition(engine, time_partition, iot_table_name, meta_table_name, statement_full)

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/preparing_source_data/load_source_data/import_data_with_meta_postgres/load_iot_data/load_iot_data_partition/__init__.py

@@ -0,0 +1,24 @@
+
+import pandas as pd
+
+def load_iot_data_partition(engine, time_range, iot_table_name, id_list_part):
+
+    time_condition = f""" ((time >= '{time_range[0]}') and (time < '{time_range[1]}')) """
+
+    id_list_str = str(tuple(id_list_part)).replace('),)', '))')
+
+    data_query = f"""select time, id, kwh*6000 as W from {iot_table_name} 
+                where id in {id_list_str}
+                    and {time_condition};"""
+
+    # print('data_query: ', data_query)
+
+    with engine.connect() as conn:
+        df_iot_part_iter = pd.read_sql_query(data_query, con=conn, chunksize=5000)
+
+    df_iot_part = pd.DataFrame([])
+
+    for df_iot_part_i in df_iot_part_iter:
+        df_iot_part = pd.concat([df_iot_part, df_iot_part_i])
+
+    return df_iot_part

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/preparing_source_data/load_source_data/import_data_with_meta_postgres/load_metadata/__init__.py

@@ -0,0 +1,34 @@
+
+import pandas as pd
+
+from .get_meta_statement import get_meta_statement
+
+def load_metadata(engine, table_name_meta, building_id, 
+                #   organisation=None,  
+                  exception=None):
+
+    statement_full = get_meta_statement(building_id, 
+                    #    organisation=organisation, 
+                       exception=exception, # the filter will be applied to link type
+                      )
+    
+    # print('statement_full: ', statement_full)
+
+    meta_query = f"""select id, 
+                            org,
+                            building_name,
+                            thing_name, 
+                            thing_type, 
+                            thing_category,
+                            variable,
+                            phase,
+                            nid,
+                            channel,
+                            hardware_id
+                            from {table_name_meta} 
+                            where {statement_full};"""
+
+    with engine.connect() as conn:
+        df_meta = pd.read_sql_query(meta_query, con=conn)
+
+    return df_meta

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/preparing_source_data/load_source_data/import_data_with_meta_postgres/load_metadata/get_meta_statement/__init__.py

@@ -0,0 +1,32 @@
+
+
+def get_meta_statement(building_id, 
+                    #    organisation=None, 
+                       exception=None,
+                      ):
+
+    statement_list = [f"""root_id='{building_id}'""", "thing_id is not null", "thing_name is not null"] # please note that the mt. lt. shortname for tables are still coupled with function load_metadata. Update - 20240814, resolved.
+
+    # if organisation != None:
+    #     statement_new  = f"""btrim(org) = '{organisation}'"""
+    #     statement_list.append(statement_new)
+
+    if exception != None:
+        for key in exception:
+            is_list = isinstance(exception[key], list) 
+            
+            if is_list:
+                exc_list = exception[key]
+            else:
+                exc_list = [exception[key]]
+            
+            exc_list_with_quote = [f"'{item}'" for item in exc_list]
+
+            exc_concat_str = ', '.join(exc_list_with_quote)
+
+            statement_new  = f"""{key} not in ({exc_concat_str})"""
+            statement_list.append(statement_new)
+
+    statement_full = " and ".join(statement_list)
+
+    return statement_full

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/preparing_source_data/load_source_data/query_building_total/__init__.py

@@ -0,0 +1,40 @@
+import pandas as pd
+
+def query_building_total(db, start_time, end_time, building_id, 
+                        #  organisation=None,
+                         timezone='UTC'):
+
+    query_start_time = pd.Timestamp(start_time, tz=timezone)
+    query_end_time  =  pd.Timestamp(end_time, tz=timezone)
+
+    query_start_time_str = query_start_time.strftime("%Y-%m-%d %H:%M:%S.%f%z")
+    query_end_time_str   = query_end_time.strftime("%Y-%m-%d %H:%M:%S.%f%z")
+
+    # print('query_start_time_str: ', query_start_time_str)
+    # print('query_end_time_str: ', query_end_time_str)
+
+
+    time_period = f"""(time >= '{query_start_time_str}') and (time < '{query_end_time_str}')"""
+
+    statement_list = [f"""building_id = '{building_id}'"""]
+    
+    # if organisation != None:
+    #     statement_new = f"""btrim("organisation") = '{organisation}'"""
+    #     statement_list.append(statement_new)
+
+    statement_full = ' and '.join(statement_list)
+
+    query = f"""select time, kwh from {db.table_building_total.name} where {statement_full} and {time_period};"""
+
+    # year, month, building_name, organisation, building_id, org_id
+
+    # print('building_total query: ', query)
+
+    engine = db.engine 
+
+    with engine.connect() as conn:
+    
+        df_meta_with_value = pd.read_sql_query(query, con=conn)
+
+
+    return df_meta_with_value

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/preparing_source_data/refine_group_name/__init__.py

@@ -0,0 +1,20 @@
+
+from mdl.utils_ import modify_group_names
+from .exchange_group_name_column import exchange_group_name_column
+
+def refine_group_name(df_meta_with_value, 
+                      asset_group, 
+                      group_name_column_exchange, 
+                      fillna_value,
+                      group_name_modification):
+    
+    df_meta_with_value = exchange_group_name_column(df_meta_with_value, 
+                                                    group_name_column_exchange, 
+                                                    asset_group)
+    
+    df_meta_with_value[asset_group] = df_meta_with_value[asset_group].fillna(fillna_value) 
+
+    df_meta_with_value = modify_group_names(df_meta_with_value, 
+                                            group_name_column=asset_group,
+                                            modification_dict=group_name_modification) 
+    return df_meta_with_value

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/preparing_source_data/refine_group_name/exchange_group_name_column/__init__.py

@@ -0,0 +1,10 @@
+
+
+def exchange_group_name_column(df_meta_with_value, group_name_column_exchange, asset_group_column):
+
+    # for the special groups where we need to use a different column_name as group_name
+    for special_group_name in group_name_column_exchange:
+        special_group_index = (df_meta_with_value[asset_group_column] == special_group_name)
+        df_meta_with_value.loc[special_group_index, asset_group_column] = df_meta_with_value.loc[special_group_index, group_name_column_exchange[special_group_name]]
+
+    return df_meta_with_value

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/preparing_source_data/validate_data_not_empty/__init__.py

@@ -0,0 +1,9 @@
+
+
+def validate_data_not_empty(df_meta_with_value, df_meta_with_value_building):
+    
+    if df_meta_with_value.shape[0] == 0:
+        raise Exception(f'The dataframe [df_meta_with_value] is empty!')
+    
+    if df_meta_with_value_building.shape[0] == 0:
+        raise Exception(f'The dataframe [df_meta_with_value_building] is empty!')

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/select_sites_and_emails/__init__.py

@@ -0,0 +1,19 @@
+
+from cache_return import cache_return
+
+@cache_return
+def select_sites_and_emails(df_config, mode, reviewer_emails):
+
+    if mode == 'publish':
+        df_config_select = df_config.loc[df_config.publish]
+        df_config_select['send_to'] = df_config_select.mailing_list
+    elif mode == 'review':
+        df_config_select = df_config.loc[df_config.publish]
+        df_config_select['send_to'] = [reviewer_emails for _ in df_config_select.index] # assigning the same emails to every site
+    elif mode == 'testing':
+        df_config_select = df_config.loc[df_config.testing]
+        df_config_select['send_to'] = [reviewer_emails for _ in df_config_select.index]
+    else:
+        raise Exception('Please provide the right mode [publish, review, testing].')
+    
+    return df_config_select

mindsett_energy_reports_pkg/mdl/utils_/__init__.py

@@ -0,0 +1,17 @@
+
+from .send_email import send_email
+from .get_group_with_others import get_group_with_others
+from .enriching_time_features import enriching_time_features
+from .modify_group_names import modify_group_names
+from .delete_files_in_directory import delete_files_in_directory
+from .color_dict import color_dict
+from .generate_time_partition_list import generate_time_partition_list
+from .cache_obj import cache_obj
+from .setup_table import setup_table
+from .setup_table import empty_table
+from .patch_missing_periods import patch_missing_periods
+from .cache_df_to_db import cache_df_to_db
+from .plot_stacked_barchart import plot_stacked_barchart
+from .get_pos_bot_range_unit_format import get_pos_bot_range_unit_format
+
+