ITR.portfolio_coverage_tvp
Classes
Lookup the companies in the given portfolio and determine whether they have a SBTi approved target. |
Module Contents
- class ITR.portfolio_coverage_tvp.PortfolioCoverageTVP(config: Type[ITR.configs.PortfolioCoverageTVPConfig] = PortfolioCoverageTVPConfig, cta_file_path: str | None = None)
Bases:
ITR.portfolio_aggregation.PortfolioAggregationLookup the companies in the given portfolio and determine whether they have a SBTi approved target.
- Parameters:
config – A class defining the constants that are used throughout this class. This parameter is only required if you’d like to overwrite a constant. This can be done by extending the PortfolioCoverageTVPConfig class and overwriting one of the parameters.
cta_file_path – Optional path to a user-provided CTA file. If set, the file will be used instead of downloading from the internet.
- cta_file_path = None
- _enrich_sbti_validated(company_data: pandas.DataFrame) pandas.DataFrame
Load the CTA file and enrich the company data with the sbti_validated status. Skipped if sbti_validated is already populated in the data.
- get_portfolio_coverage(company_data: pandas.DataFrame, portfolio_aggregation_method: ITR.portfolio_aggregation.PortfolioAggregationMethod) float | None
Get the TVP portfolio coverage (i.e. what part of the portfolio has a SBTi validated target). Loads the CTA file and enriches company data with sbti_validated status before computing coverage, unless sbti_validated is already populated.
- Parameters:
company_data – The company as it is returned from the data provider’s get_company_data call.
portfolio_aggregation_method – PortfolioAggregationMethod: The aggregation method to use
- Returns:
The aggregated score