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/plot_adaptive_ring_with_phase/plot_ring/__init__.py

@@ -0,0 +1,87 @@
+
+import matplotlib.pyplot as plt
+import copy
+
+from .adjust_gap_for_visibility import adjust_gap_for_visibility
+from .adjust_to_inner_ring import adjust_to_inner_ring
+from .annotate_pct_on_pies import annotate_pct_on_pies
+from .generate_pct_fmt import generate_pct_fmt
+from .adjust_values_for_better_visibility import adjust_values_for_better_visibility
+
+
+def plot_ring(sr_orig, ax,
+                colors=None,
+                hatch=None,
+                fontsize=None,
+                as_inner_ring=None,
+                inner_radius=None,
+                outer_radius=None,
+                gap_value=None, 
+                ann_pct=None,
+                pct_out=None, 
+                pct_hide=None):
+    
+    if fontsize is None:
+        fontsize = 13
+    if colors is None:
+        colors = ['#fffffc'] # use this modification of white color to differentiate it from the actual white, for legend handle filter
+    if as_inner_ring is None:
+        as_inner_ring = False
+    if inner_radius is None:
+        inner_radius = 0.5
+    if outer_radius is None:
+        outer_radius = 1
+    if ann_pct is None:
+        ann_pct = True
+    if gap_value is None:
+        gap_value = 0
+    
+    sr = adjust_values_for_better_visibility(sr_orig) # to avoid changes made to the original series
+
+    ls_orig_pct_fmt = generate_pct_fmt(sr)
+    
+    if gap_value > 0:
+
+        sr_sum_without_gap = sr.sum()
+
+        # to make the non-gap pie or gap pie more visible
+        sr['Gap Value'] = adjust_gap_for_visibility(gap_value, sr_sum_without_gap, 
+                                                    min_vis_pct=3)
+        
+    sr.plot.pie(ax=ax, 
+                autopct='', # needed to generate placeholder for ax.texts
+                colors=colors,
+                hatch=hatch,
+                radius=outer_radius,
+                # frame=True,
+                textprops={"color": 'k', 
+                            "fontsize": fontsize}, 
+                pctdistance=0.77,
+                wedgeprops={'linewidth': 1, 
+                            "edgecolor": 'k'}, 
+                startangle=90,
+                labels=None)
+    
+    if gap_value > 0:
+        patch_for_gap = copy.copy(ax.patches[-1])
+        ax.patches[-1].set(visible=False, gid='no legend')
+
+    if ann_pct:
+        annotate_pct_on_pies(ax, sr, ls_orig_pct_fmt, 
+                            pct_hide=pct_hide,
+                            pct_out=pct_out)
+    
+    # plot the circle in the centre of the ring
+    inner_circle = plt.Circle((0, 0), inner_radius, 
+                              facecolor='w', 
+                              linewidth=1, 
+                              edgecolor='k') # edgecolor=other_colours[0], 
+    # p = plt.gcf()
+    # p.gca().add_artist(inner_circle)
+    ax.add_artist(inner_circle)
+
+    if gap_value > 0:
+        adjust_to_inner_ring(ax, patch_for_gap, inner_radius, outer_radius, 
+                        as_inner_ring=as_inner_ring)
+
+    ax.set_ylabel("")

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/plot_ring/adjust_gap_for_visibility/__init__.py

@@ -0,0 +1,19 @@
+
+
+def adjust_gap_for_visibility(gap_value, non_gap_value, 
+                              min_vis_pct=None):
+    
+    if min_vis_pct is None:
+        min_vis_pct = 3
+
+    min_non_gap_pct = min_vis_pct
+    max_non_gap_pct = 100 - min_non_gap_pct
+
+    max_gap_for_visibility = (100 - min_non_gap_pct)*non_gap_value/min_non_gap_pct
+    min_gap_for_visibility = (100 - max_non_gap_pct)*non_gap_value/max_non_gap_pct
+
+    adj_gap_for_visibility = gap_value
+    adj_gap_for_visibility = min(max_gap_for_visibility, adj_gap_for_visibility)
+    adj_gap_for_visibility = max(min_gap_for_visibility, adj_gap_for_visibility)
+
+    return adj_gap_for_visibility

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/plot_ring/adjust_to_inner_ring/__init__.py

@@ -0,0 +1,32 @@
+
+import matplotlib.pyplot as plt
+
+def adjust_to_inner_ring(ax, patch_for_gap, inner_radius, outer_radius, 
+                         as_inner_ring=None):
+
+    if as_inner_ring is None:
+        as_inner_ring = False
+    
+    if as_inner_ring:
+
+        # remove the inner line
+        patch_for_gap.set(
+                edgecolor=None,
+                facecolor='w',
+                hatch=None,
+                radius=inner_radius+0.01, # added 0.01 to completely remove/cover the black line
+                gid='no legend',
+                )
+        # p = plt.gcf()
+        # p.gca().add_artist(patch_for_gap)
+        ax.add_artist(patch_for_gap)
+
+        # add the outer line
+        outer_circle = plt.Circle((0, 0), outer_radius, 
+                                    fill=False, 
+                                    linewidth=1, 
+                                    gid='no legend',
+                                    edgecolor='k') # edgecolor=other_colours[0], 
+        # p = plt.gcf()
+        # p.gca().add_artist(outer_circle)
+        ax.add_artist(outer_circle)

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/plot_ring/adjust_values_for_better_visibility/__init__.py

@@ -0,0 +1,27 @@
+
+
+def adjust_values_for_better_visibility(sr_orig,
+                                        thres_invisibity=0.01,
+                                        adjustment_pct=0.01):
+
+    # ensure that the pct is positive 
+    sr_orig_abs = sr_orig.abs()
+    sr_plot_pct = sr_orig_abs/sr_orig_abs.sum()
+
+    # print(f'{sr_plot_pct = }')
+
+    # label the non-visible
+    non_visible_index = sr_plot_pct.loc[sr_plot_pct<thres_invisibity].index
+    all_visible_index = sr_plot_pct.index.difference(non_visible_index)
+
+    # slightly adjust the values to make the non-visible ones more visible
+    previous_non_visiable_pct = sr_plot_pct.loc[non_visible_index].sum()
+    sr_plot_pct.loc[non_visible_index] = sr_plot_pct.loc[non_visible_index] + adjustment_pct
+    improved_non_visiable_pct = sr_plot_pct.loc[non_visible_index].sum()
+
+    sr_plot_pct.loc[all_visible_index] = sr_plot_pct.loc[all_visible_index] * (1-improved_non_visiable_pct)/(1-previous_non_visiable_pct)
+
+    # get the adjusted sum values for plots
+    sr_plot_sum = sr_plot_pct * sr_orig.sum()
+
+    return sr_plot_sum

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/plot_ring/annotate_pct_on_pies/__init__.py

@@ -0,0 +1,21 @@
+
+
+def annotate_pct_on_pies(ax, sr, ls_orig_pct_fmt, 
+                        pct_hide=None,
+                        pct_out=None):
+    
+    if pct_hide is None:
+        pct_hide = 0.04
+
+    if pct_out is None:
+        pct_out = 0.065
+
+    for index, pct_value in enumerate(sr.to_list()):
+
+        ax.texts[index*2+1].update({"text": ls_orig_pct_fmt[index]})
+
+        if abs(pct_value) < pct_hide * sr.sum(): 
+            ax.texts[index*2+1].update({"text": ''})
+        elif abs(pct_value) < pct_out * sr.sum(): 
+            ax.texts[index*2].update({"text": f'{ax.texts[index*2+1].get_text()}'})
+            ax.texts[index*2+1].update({"text": ''})

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/plot_ring/generate_pct_fmt/__init__.py

@@ -0,0 +1,8 @@
+
+
+def generate_pct_fmt(sr):
+    total_before_adding_gap = sr.sum()
+    ls_orig_pct = (sr/total_before_adding_gap).to_list()
+    ls_orig_pct_fmt = ['{:.0f}%'.format(round(p*100)) for p in ls_orig_pct]
+    ls_orig_pct_fmt.append('') # add for potential gap value
+    return ls_orig_pct_fmt

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/show_legend/__init__.py

@@ -0,0 +1,36 @@
+
+
+from .get_legend_handles import get_legend_handles
+from .generate_legend_labels import generate_legend_labels
+
+def show_legend(ax, df_pre_pie, 
+                fontsize=None,
+                sum_column=None, 
+                pct_column=None):
+    
+    if fontsize is None:
+        fontsize = 13
+
+    valid_handles = get_legend_handles(ax)
+    legend_labels = generate_legend_labels(df_pre_pie, 
+                                            sum_column=sum_column, 
+                                            pct_column=pct_column)
+
+    x0, y0, width, height = 1.15, 0.5, 0, 0 
+    leg_ncol = 1
+    leg_loc = 'center left'
+
+    leg = ax.legend(handles=valid_handles,
+                    labels=legend_labels,
+                    loc=leg_loc,
+                    facecolor='w', 
+                    edgecolor='w',
+                    borderaxespad=0,
+                    bbox_to_anchor=(x0, y0, width, height), 
+                    fontsize=fontsize,  
+                    ncol=leg_ncol, 
+                    handleheight=1.2, 
+                    labelspacing=0.6, 
+                    title=None)
+
+    leg.set_in_layout(False)

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/show_legend/generate_legend_labels/__init__.py

@@ -0,0 +1,50 @@
+
+
+from .get_formatted_sum import get_formatted_sum
+from .get_formatted_arrow import get_formatted_arrow
+from .get_formatted_pct import get_formatted_pct
+from .get_formatted_name import get_formatted_name
+
+
+def generate_legend_labels(df_asset_class_monthly_sum_others, # this dataframe is required to have asset class as index and have columns "sub_pct", "sum"
+                            sum_column = None,
+                            pct_column = None,
+                            # space_len_long = 5,
+                            space_len_short = None,
+                            pct_len = None,
+                            kwh_len = None):
+    
+    if sum_column is None:
+        sum_column = "sum"
+    if pct_column is None:
+        pct_column = "sub_pct"
+    if space_len_short is None:
+        space_len_short = 1
+
+    labels = []
+
+    # label_space_long = "," + " "*space_len_long 
+    label_space_short = " "*space_len_short
+
+    for index, item in df_asset_class_monthly_sum_others.iterrows():
+
+        # print(f'{index = }')
+
+        # print(f'{item = }')
+        # print(f'{pct_column = }')
+
+        label_kwh = get_formatted_sum(item[sum_column], 
+                                     sum_value_len=kwh_len)
+        label_arrow = get_formatted_arrow(item[pct_column])
+        label_pct = get_formatted_pct(item[pct_column],
+                                      pct_len=pct_len)
+
+        label_name = get_formatted_name(index)
+
+        label = label_kwh + label_space_short + label_arrow+ " " + label_pct + label_space_short + label_name
+
+        # print(f'{label = }')
+
+        labels.append(label)
+        
+    return labels

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/show_legend/generate_legend_labels/get_formatted_arrow/__init__.py

@@ -0,0 +1,18 @@
+
+
+
+def get_formatted_arrow(pct_value):
+
+    if pct_value > 0.005: 
+            label_arrow_str = r'${\blacktriangle}$'
+
+    elif pct_value < -0.005:
+        label_arrow_str = r'$\:\!\triangledown\:\!$'
+
+    else:
+        label_arrow_str = r'$\!$--'
+    
+    label_arrow_pad = ' '
+    label_arrow = label_arrow_pad + label_arrow_str
+
+    return label_arrow

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/show_legend/generate_legend_labels/get_formatted_name/__init__.py

@@ -0,0 +1,14 @@
+
+
+def get_formatted_name(name_text, 
+                       max_len=None):
+    
+    if max_len is None:
+        max_len = 15
+
+    if len(name_text) > max_len:
+        label_name = name_text[:(max_len-3)]+"..."
+    else:   
+        label_name = name_text
+
+    return label_name

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/show_legend/generate_legend_labels/get_formatted_pct/__init__.py

@@ -0,0 +1,44 @@
+
+
+
+def get_formatted_pct(pct_value, 
+                      pct_len=None):
+    
+    if pct_len is None:
+        pct_len = 2
+
+    # format the relative change
+
+    pad_for_3_digit = 1
+
+    if abs(pct_value) <= 1.06:
+        label_pct_str = str(round(abs(pct_value)*100))
+        label_pct_unit = r"%"
+        label_pct_dot = " "*label_pct_str.count('.')
+        label_pct_pad = ' ' *int((pct_len - len(label_pct_str))*2 + pad_for_3_digit) 
+    elif abs(pct_value) < 1000:
+        label_pct_str = str(round(abs(pct_value))) # todo: config number of decimals
+        if len(label_pct_str) < 2:
+            label_pct_str = str(round(abs(pct_value)*10)/10) # add one decimal
+        label_pct_unit = r"X"
+        label_pct_dot = " "*label_pct_str.count('.')
+        label_pct_pad = ' ' *int((pct_len - len(label_pct_str))*2 +1 + pad_for_3_digit)
+    elif abs(pct_value) < 1000_000:
+        label_pct_str = str(round(abs(pct_value)/1000)) # todo: config number of decimals
+        if len(label_pct_str) < 2:
+            label_pct_str = str(round(abs(pct_value)/1000*10)/10) # add one decimal
+        label_pct_unit = r"KX"
+        label_pct_dot = " "*label_pct_str.count('.')
+        label_pct_pad = ' ' *int((pct_len - len(label_pct_str))*2 -1 + pad_for_3_digit)
+    else:
+        label_pct_str = str(round(abs(pct_value)/1000_000)) # todo: config number of decimals
+        if len(label_pct_str) < 2:
+            label_pct_str = str(round(abs(pct_value)/1000_1000*10)/10) # add one decimal
+        label_pct_unit = r"MX"
+        label_pct_dot = " "*label_pct_str.count('.')
+        label_pct_pad = ' ' *int((pct_len - len(label_pct_str))*2 -2 + pad_for_3_digit)
+
+    # print(f'label_pct_pad = "{label_pct_pad}"')
+    label_pct = label_pct_dot + label_pct_pad + label_pct_str + label_pct_unit + ',' + ' ' * 5
+
+    return label_pct

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/show_legend/generate_legend_labels/get_formatted_sum/__init__.py

@@ -0,0 +1,31 @@
+
+
+def get_formatted_sum(value, 
+                     sum_value_len=None):
+    
+    if sum_value_len is None:
+        sum_value_len = 8
+
+    # adjust the decimal point and the unit based on the actual value
+    sum_abs = abs(value)
+    if sum_abs >= 99_950: # KWH
+        label_kwh_str = f'{value/1000:4.0f} MWh'
+    elif sum_abs >= 1000: # KWH
+        label_kwh_str = f'{value/1000:4.1f} MWh'
+    elif sum_abs >= 99.95: # KWH 
+        label_kwh_str = f'{value:4.0f} KWh' # to handle the case that (sum_abs:  99.98276) => (100.0 KWh)
+    elif sum_abs >= 1:
+        label_kwh_str = f'{value:4.1f} KWh'
+    elif sum_abs >= 0.09995:
+        label_kwh_str = f'{value*1000:4.0f} Wh'
+    else:
+        label_kwh_str = f'{value*1000:4.1f} Wh'
+
+    label_kwh_str_strip = label_kwh_str.strip()
+
+    label_kwh_pad_digi = ' ' *int((sum_value_len - len(label_kwh_str_strip))*2)
+    label_kwh_pad_dot = ' '*label_kwh_str_strip.count('.')
+
+    label_kwh = label_kwh_pad_dot + label_kwh_pad_digi + label_kwh_str_strip + ','
+
+    return label_kwh

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/plot_adaptive_ring_with_phase/show_legend/get_legend_handles/__init__.py

@@ -0,0 +1,22 @@
+
+
+def get_legend_handles(ax, no_of_labels=50):
+
+    ax.legend(labels=['']*no_of_labels)
+
+    legends = ax.get_legend()
+
+    valid_handles = []
+
+    for handle in legends.legend_handles:
+
+        is_invisible_pie_for_gap = (handle.get_visible()==False)
+        is_white_pie_in_ring_centre = (handle.get_fc() == (1.0, 1.0, 1.0, 1))
+        is_outer_gap_edge_when_as_inner = (handle.get_fc()[3]==0)
+
+        invalid_handle = (is_invisible_pie_for_gap or is_white_pie_in_ring_centre or is_outer_gap_edge_when_as_inner)
+
+        if not invalid_handle: 
+            valid_handles.append(handle)
+
+    return valid_handles

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/preprocessing_for_phases/__init__.py

@@ -0,0 +1,37 @@
+
+
+def preprocessing_for_phases(df_meta_with_value, 
+                    reading_interval_in_mins=None):
+
+    if reading_interval_in_mins is None:
+        reading_interval_in_mins=10
+
+    # Conversion into MWh
+    w_to_kw_para = 1./1000
+    min_to_hour_para = 1./60
+
+    wm_to_kwh_parameter = w_to_kw_para * min_to_hour_para
+    reading_to_kwh_parameter = reading_interval_in_mins * wm_to_kwh_parameter
+
+    # consider only the consumed energy
+    df_meta_with_value_positive = df_meta_with_value.loc[df_meta_with_value["W"] > 0]
+
+    # group and pivot operation
+    sr_group_phase = df_meta_with_value_positive.groupby(["phase"])["W"].sum() * reading_to_kwh_parameter
+
+    # extract phase values to list and report possible anomalies
+    existing_phases = sr_group_phase.index.to_list()
+    phase_values_list = []
+
+    for phase in ['L1', 'L2', 'L3']:
+        if phase in existing_phases:
+            phase_values_list.append(sr_group_phase[phase])
+        else:
+            print(f'[WARN]: missing phase "{phase}"!')
+            phase_values_list.append(0)
+
+    for phase in existing_phases:
+        if phase not in ['L1', 'L2', 'L3']:
+            print(f'[WARN]: unexpected phase "{phase}"!')
+
+    return phase_values_list

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

@@ -0,0 +1,26 @@
+
+from .group_and_pivot import group_and_pivot
+from .transform_asset_stats_for_adaptive_piechart import transform_asset_stats_for_adaptive_piechart
+
+def preprocessing_for_piechart(df_meta_with_value,
+                               reading_interval_in_mins=None,
+                               asset_group=None,
+                               minimum_cnt_for_protection=None,
+                                max_display_cnt=None,
+                                sum_column=None, 
+                                pct_column=None,
+                                gene_column=None):
+
+    df_pivot_asset_group_by_period = group_and_pivot(df_meta_with_value, 
+                                                    reading_interval_in_mins=reading_interval_in_mins,
+                                                    asset_group=asset_group)
+
+    df_sort_idx_trim = transform_asset_stats_for_adaptive_piechart(df_pivot_asset_group_by_period,
+                                                                    minimum_cnt_for_protection=minimum_cnt_for_protection,
+                                                                    max_display_cnt=max_display_cnt,
+                                                                    sum_column=sum_column, 
+                                                                    pct_column=pct_column,
+                                                                    gene_column=gene_column,
+                                                                    asset_group=asset_group)
+    
+    return df_sort_idx_trim

mindsett_energy_reports_pkg/mdl/prepare_and_email_reports/prepare_report/generate_components/generate_piechart_with_phase/preprocessing_for_piechart/group_and_pivot/__init__.py

@@ -0,0 +1,24 @@
+
+
+def group_and_pivot(df_meta_with_value, 
+                    asset_group=None,
+                    reading_interval_in_mins=None):
+
+    if asset_group is None:
+        asset_group = 'thing_category'
+
+    if reading_interval_in_mins is None:
+        reading_interval_in_mins=10
+
+    # Conversion into MWh
+    w_to_kw_para = 1./1000
+    min_to_hour_para = 1./60
+
+    wm_to_kwh_parameter = w_to_kw_para * min_to_hour_para
+    reading_to_kwh_parameter = reading_interval_in_mins * wm_to_kwh_parameter
+
+    # group and pivot operation
+    sr_pivot_asset_class = df_meta_with_value.groupby([asset_group, "period"])["W"].sum() * reading_to_kwh_parameter
+    df_pivot_asset_group_by_period = sr_pivot_asset_class.unstack(["period"])
+
+    return df_pivot_asset_group_by_period

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/__init__.py

@@ -0,0 +1,30 @@
+
+from .get_sum_for_curr_and_prev import get_sum_for_curr_and_prev
+from .get_subgroup_sum_and_rank import get_subgroup_sum_and_rank
+from .get_rank_overall_protect import get_rank_overall_protect
+from .get_entries_to_display import get_entries_to_display
+from .get_change_pct_and_sort_and_trim_cols import get_change_pct_and_sort_and_trim_cols
+
+
+def transform_asset_stats_for_adaptive_piechart(df_pivot_asset_group_by_period,
+                                                      minimum_cnt_for_protection=None,
+                                                      max_display_cnt=None,
+                                                      sum_column = None, 
+                                                      pct_column = None,
+                                                      gene_column=None,
+                                                      asset_group=None):
+
+    df_pivot_asset_group_by_period_renamed = get_sum_for_curr_and_prev(df_pivot_asset_group_by_period)
+    df_pivot_asset_group_by_period_renamed = get_subgroup_sum_and_rank(df_pivot_asset_group_by_period_renamed)
+    df_pivot_asset_group_by_period_renamed_rdx = get_rank_overall_protect(df_pivot_asset_group_by_period_renamed, 
+                                                                        minimum_cnt_for_protection=minimum_cnt_for_protection)
+    df_pivot_asset_group_by_period_renamed_rdx_to_keep = get_entries_to_display(df_pivot_asset_group_by_period_renamed_rdx,
+                                                                                    max_display_cnt=max_display_cnt,
+                                                                                    gene_column=gene_column,
+                                                                                    asset_group=asset_group)
+    df_sort_idx_trim = get_change_pct_and_sort_and_trim_cols(df_pivot_asset_group_by_period_renamed_rdx_to_keep,
+                                                sum_column = sum_column, 
+                                                pct_column = pct_column,
+                                                gene_column = gene_column,
+                                                asset_group = asset_group)
+    return df_sort_idx_trim

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_change_pct_and_sort_and_trim_cols/__init__.py

@@ -0,0 +1,34 @@
+
+
+
+def get_change_pct_and_sort_and_trim_cols(df_pivot_asset_group_by_period_renamed_rdx_to_keep,
+                                            sum_column = None, 
+                                            pct_column = None,
+                                            gene_column = None,
+                                            asset_group = None):
+    
+    if sum_column is None:
+        sum_column = "sum_abs"
+
+    if pct_column is None:
+        pct_column = 'sub_pct'
+
+    if gene_column is None:
+        gene_column = 'generator'
+
+    if asset_group is None:
+        asset_group = 'thing_category'
+
+    # calculate the percentage of changes
+    df_pivot_asset_group_by_period_renamed_rdx_to_keep[pct_column] = df_pivot_asset_group_by_period_renamed_rdx_to_keep['sub'] / df_pivot_asset_group_by_period_renamed_rdx_to_keep['sum']
+
+    # sort the list
+    df_pivot_asset_group_by_period_renamed_rdx_to_keep_sort = df_pivot_asset_group_by_period_renamed_rdx_to_keep.sort_values([gene_column, 'rank_in_group'])
+
+    # the plotting function requires asset_group to be the index
+    df_pivot_asset_group_by_period_renamed_rdx_to_keep_sort_idx = df_pivot_asset_group_by_period_renamed_rdx_to_keep_sort.set_index([asset_group])
+
+    columns_for_export = [sum_column, pct_column, gene_column]
+    df_pivot_asset_group_by_period_renamed_rdx_to_keep_sort_idx_trim = df_pivot_asset_group_by_period_renamed_rdx_to_keep_sort_idx[columns_for_export]
+
+    return df_pivot_asset_group_by_period_renamed_rdx_to_keep_sort_idx_trim

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_entries_to_display/__init__.py

@@ -0,0 +1,34 @@
+
+
+def get_entries_to_display(df_pivot_asset_group_by_period_renamed_rdx,
+                           max_display_cnt=None,
+                           gene_column=None,
+                           asset_group=None):
+
+    if max_display_cnt is None:
+        max_display_cnt = 8
+    
+    if gene_column is None:
+        gene_column = 'generator'
+
+    if asset_group is None:
+        asset_group = 'thing_category'
+
+    # get the rows to keep/display and redundant rows to merge
+    df_pivot_asset_group_by_period_renamed_rdx['to_be_merged'] = df_pivot_asset_group_by_period_renamed_rdx['rank_overall_protect'] > max_display_cnt
+    df_pivot_asset_group_by_period_renamed_rdx_to_merge = df_pivot_asset_group_by_period_renamed_rdx.loc[df_pivot_asset_group_by_period_renamed_rdx['to_be_merged']]
+    df_pivot_asset_group_by_period_renamed_rdx_to_keep = df_pivot_asset_group_by_period_renamed_rdx.loc[~df_pivot_asset_group_by_period_renamed_rdx['to_be_merged']]
+    df_pivot_asset_group_by_period_renamed_rdx_to_merge_grp = df_pivot_asset_group_by_period_renamed_rdx_to_merge.groupby([gene_column]).agg({'sum': 'sum', 
+                                                                                                                                              'sum_pre': 'sum', 
+                                                                                                                                              'sub': 'sum'})
+
+    # merge the redundant rows to "others" in the rows to keep
+    for gene, sr_gene in df_pivot_asset_group_by_period_renamed_rdx_to_merge_grp.iterrows():
+
+        idx_last_row = df_pivot_asset_group_by_period_renamed_rdx_to_keep.loc[df_pivot_asset_group_by_period_renamed_rdx_to_keep[gene_column]==gene].index.max()
+        df_pivot_asset_group_by_period_renamed_rdx_to_keep.loc[idx_last_row, asset_group] = 'Other Assets' if gene==False else 'Other Sources'
+
+        for column in df_pivot_asset_group_by_period_renamed_rdx_to_merge_grp.columns:
+            df_pivot_asset_group_by_period_renamed_rdx_to_keep.loc[idx_last_row, column] += sr_gene[column]
+
+    return df_pivot_asset_group_by_period_renamed_rdx_to_keep

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_rank_overall_protect/__init__.py

@@ -0,0 +1,14 @@
+
+
+def get_rank_overall_protect(df_pivot_asset_group_by_period_renamed, 
+                             minimum_cnt_for_protection=None):
+
+    if minimum_cnt_for_protection is None:
+        minimum_cnt_for_protection = 3
+
+    # get the overall ranking considering the minimum entries to protect
+    df_pivot_asset_group_by_period_renamed['protect_in_group'] = (df_pivot_asset_group_by_period_renamed['rank_in_group'] <= minimum_cnt_for_protection)
+    df_pivot_asset_group_by_period_renamed_rdx = df_pivot_asset_group_by_period_renamed.sort_values(by=['protect_in_group', 'sum_abs'], ascending=False).reset_index()
+    df_pivot_asset_group_by_period_renamed_rdx['rank_overall_protect'] = df_pivot_asset_group_by_period_renamed_rdx.index + 1
+
+    return df_pivot_asset_group_by_period_renamed_rdx

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_subgroup_sum_and_rank/__init__.py

@@ -0,0 +1,22 @@
+
+
+def get_subgroup_sum_and_rank(df_pivot_asset_group_by_period_renamed,
+                              sum_column = None, 
+                              gene_column = None):
+    
+    if sum_column is None:
+        sum_column = "sum_abs"
+
+    if gene_column is None:
+        gene_column = 'generator'
+
+    # label the entries based on whether generator or not and add sub-group total
+    df_pivot_asset_group_by_period_renamed[gene_column] = df_pivot_asset_group_by_period_renamed['sum'] < 0
+    # df_pivot_asset_group_by_period_tot = df_pivot_asset_group_by_period_renamed.groupby([gene_column])['sum'].sum().rename('generator_tot')
+    # df_pivot_asset_group_by_period_renamed = df_pivot_asset_group_by_period_renamed.merge(df_pivot_asset_group_by_period_tot, left_on=[gene_column], right_index=True)
+
+    # get the rank in sub-group
+    df_pivot_asset_group_by_period_renamed[sum_column] = df_pivot_asset_group_by_period_renamed['sum'].abs()
+    df_pivot_asset_group_by_period_renamed['rank_in_group'] = df_pivot_asset_group_by_period_renamed.groupby(gene_column)[sum_column].rank(ascending=False, method="dense")
+
+    return df_pivot_asset_group_by_period_renamed