mescal.contribution_analysis
============================

.. py:module:: mescal.contribution_analysis


Classes
-------

.. autoapisummary::

   mescal.contribution_analysis.ABContributionAnalysis


Functions
---------

.. autoapisummary::

   mescal.contribution_analysis._export_comprehensive_excel
   mescal.contribution_analysis.process_contribution_data


Module Contents
---------------

.. py:class:: ABContributionAnalysis

   Bases: :py:obj:`bw2analyzer.ContributionAnalysis`


   Activity Browser version of bw2analyzer.ContributionAnalysis


   .. py:method:: sort_array(data: numpy.array, limit: float = 25, limit_type: str = 'number', total: Optional[float] = None) -> numpy.array

      Activity Browser version of bw2analyzer.ContributionAnalysis.sort_array.

      Should be removed once https://github.com/brightway-lca/brightway2-analyzer/pull/32 is merged.
      See PR above on why we overwrite this function.



.. py:function:: _export_comprehensive_excel(df: pandas.DataFrame, unit_type_groups_dict: dict, saving_path: str, act_types: list[str], contribution_type: str, detail_col: str) -> None

   Internal function to export comprehensive Excel file.

   :param df: DataFrame with contribution analysis results
   :param unit_type_groups_dict: Dictionary mapping (ESM, Type) to list of technology names
   :param saving_path: Output directory for Excel file
   :param act_types: List of activity types to include in Excel export
   :param contribution_type: Type of contribution analysis: 'processes' or 'emissions'
   :param detail_col: Column name for process or emission details ('process_name' or 'ef_name')
   :return: None


.. py:function:: process_contribution_data(contrib_df: pandas.DataFrame, impact_scores_df: pandas.DataFrame, unit_conversion_df: pandas.DataFrame, contribution_type: str = 'processes', saving_path: str = None, export_excel: bool = False, act_types: list[str] = None) -> tuple[pandas.DataFrame, dict]

   Process contribution analysis data for environmental impacts.

   :param contrib_df: contribution analysis dataframe (processes or emissions)
   :param impact_scores_df: impact scores dataframe with total impacts
   :param unit_conversion_df: unit conversion dataframe
   :param contribution_type: Type of contribution analysis: 'processes' or 'emissions'
   :param saving_path: Output directory for Excel file (required if export_excel=True)
   :param export_excel: Whether to export comprehensive Excel file
   :param act_types: List of activity types for Excel export
   :return: Processed DataFrame with impact_share column, Unit type groups dictionary