:py:mod:`ITR.configs` ===================== .. py:module:: ITR.configs .. autoapi-nested-parse:: This file defines the constants used throughout the different classes. In order to redefine these settings whilst using the module, extend the respective config class and pass it to the class as the "constants" parameter. Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: ITR.configs.ColumnsConfig ITR.configs.PortfolioAggregationConfig ITR.configs.TemperatureScoreConfig ITR.configs.PortfolioCoverageTVPConfig .. py:class:: ColumnsConfig .. py:attribute:: COMPANY_ID :annotation: = company_id .. py:attribute:: COMPANY_ISIN :annotation: = company_isin .. py:attribute:: COMPANY_LEI :annotation: = company_lei .. py:attribute:: COMPANY_ISIC :annotation: = isic .. py:attribute:: TARGET_IDS :annotation: = target_ids .. py:attribute:: REGRESSION_PARAM :annotation: = param .. py:attribute:: REGRESSION_INTERCEPT :annotation: = intercept .. py:attribute:: MARKET_CAP :annotation: = company_market_cap .. py:attribute:: INVESTMENT_VALUE :annotation: = investment_value .. py:attribute:: COMPANY_ENTERPRISE_VALUE :annotation: = company_enterprise_value .. py:attribute:: COMPANY_EV_PLUS_CASH :annotation: = company_ev_plus_cash .. py:attribute:: COMPANY_TOTAL_ASSETS :annotation: = company_total_assets .. py:attribute:: TARGET_REFERENCE_NUMBER :annotation: = target_type .. py:attribute:: SCOPE :annotation: = scope .. py:attribute:: SCOPE3_CATEGORY :annotation: = s3_category .. py:attribute:: AR6 :annotation: = ar6 .. py:attribute:: REDUCTION_FROM_BASE_YEAR :annotation: = reduction_from_base_year .. py:attribute:: START_YEAR :annotation: = start_year .. py:attribute:: VARIABLE :annotation: = variable .. py:attribute:: SLOPE :annotation: = slope .. py:attribute:: TIME_FRAME :annotation: = time_frame .. py:attribute:: MODEL :annotation: = model .. py:attribute:: ANNUAL_REDUCTION_RATE :annotation: = annual_reduction_rate .. py:attribute:: EMISSIONS_IN_SCOPE :annotation: = emissions_in_scope .. py:attribute:: TEMPERATURE_SCORE :annotation: = temperature_score .. py:attribute:: COMPANY_NAME :annotation: = company_name .. py:attribute:: OWNED_EMISSIONS :annotation: = owned_emissions .. py:attribute:: COUNTRY :annotation: = country .. py:attribute:: SECTOR :annotation: = sector .. py:attribute:: GHG_SCOPE1 :annotation: = ghg_s1 .. py:attribute:: GHG_SCOPE2 :annotation: = ghg_s2 .. py:attribute:: GHG_SCOPE12 :annotation: = ghg_s1s2 .. py:attribute:: GHG_SCOPE3 :annotation: = ghg_s3 .. py:attribute:: COMPANY_REVENUE :annotation: = company_revenue .. py:attribute:: CASH_EQUIVALENTS :annotation: = company_cash_equivalents .. py:attribute:: TARGET_CLASSIFICATION :annotation: = target_classification .. py:attribute:: REDUCTION_AMBITION :annotation: = reduction_ambition .. py:attribute:: BASE_YEAR :annotation: = base_year .. py:attribute:: END_YEAR :annotation: = end_year .. py:attribute:: SBTI_VALIDATED :annotation: = sbti_validated .. py:attribute:: TARGET_CONFIRM_DATE :annotation: = statement_date .. py:attribute:: ACHIEVED_EMISSIONS :annotation: = achieved_reduction .. py:attribute:: ISIC :annotation: = isic .. py:attribute:: INDUSTRY_LVL1 :annotation: = industry_level_1 .. py:attribute:: INDUSTRY_LVL2 :annotation: = industry_level_2 .. py:attribute:: INDUSTRY_LVL3 :annotation: = industry_level_3 .. py:attribute:: INDUSTRY_LVL4 :annotation: = industry_level_4 .. py:attribute:: COVERAGE_S1 :annotation: = coverage_s1 .. py:attribute:: COVERAGE_S2 :annotation: = coverage_s2 .. py:attribute:: COVERAGE_S3 :annotation: = coverage_s3 .. py:attribute:: INTENSITY_METRIC :annotation: = intensity_metric .. py:attribute:: INTENSITY_METRIC_AR6 :annotation: = intensity_metric .. py:attribute:: TARGET_TYPE_AR6 :annotation: = target_type .. py:attribute:: AR6_VARIABLE :annotation: = ar6_variable .. py:attribute:: REGRESSION_MODEL :annotation: = Regression_model .. py:attribute:: BASEYEAR_GHG_S1 :annotation: = base_year_ghg_s1 .. py:attribute:: BASEYEAR_GHG_S2 :annotation: = base_year_ghg_s2 .. py:attribute:: BASEYEAR_GHG_S1S2 :annotation: = base_year_ghg_s1s2 .. py:attribute:: BASEYEAR_GHG_S3 :annotation: = base_year_ghg_s3 .. py:attribute:: REGION :annotation: = region .. py:attribute:: ENGAGEMENT_TARGET :annotation: = engagement_target .. py:attribute:: BASE_YEAR_TS :annotation: = base_year_ts .. py:attribute:: END_YEAR_TS :annotation: = end_year_ts .. py:attribute:: TO_CALCULATE :annotation: = to_calculate .. py:attribute:: GHG_S3_1 :annotation: = ghg_s3_1 .. py:attribute:: GHG_S3_2 :annotation: = ghg_s3_2 .. py:attribute:: GHG_S3_3 :annotation: = ghg_s3_3 .. py:attribute:: GHG_S3_4 :annotation: = ghg_s3_4 .. py:attribute:: GHG_S3_5 :annotation: = ghg_s3_5 .. py:attribute:: GHG_S3_6 :annotation: = ghg_s3_6 .. py:attribute:: GHG_S3_7 :annotation: = ghg_s3_7 .. py:attribute:: GHG_S3_8 :annotation: = ghg_s3_8 .. py:attribute:: GHG_S3_9 :annotation: = ghg_s3_9 .. py:attribute:: GHG_S3_10 :annotation: = ghg_s3_10 .. py:attribute:: GHG_S3_11 :annotation: = ghg_s3_11 .. py:attribute:: GHG_S3_12 :annotation: = ghg_s3_12 .. py:attribute:: GHG_S3_13 :annotation: = ghg_s3_13 .. py:attribute:: GHG_S3_14 :annotation: = ghg_s3_14 .. py:attribute:: GHG_S3_15 :annotation: = ghg_s3_15 .. py:attribute:: PARAM :annotation: = param .. py:attribute:: INTERCEPT :annotation: = intercept .. py:attribute:: WEIGHTED_TEMPERATURE_SCORE :annotation: = weighted_temperature_score .. py:attribute:: CONTRIBUTION_RELATIVE :annotation: = contribution_relative .. py:attribute:: CONTRIBUTION :annotation: = contribution .. py:class:: PortfolioAggregationConfig .. py:attribute:: COLS .. py:class:: TemperatureScoreConfig Bases: :py:obj:`PortfolioAggregationConfig` This factor determines what part of the temperature for a not SBTi-validated company should be the TS and what part should be the default score. The calculated temperature score should not be lower than the current level of global warning which is expressed through the temperature floor constant. .. py:attribute:: SBTI_FACTOR :annotation: = 1 .. py:attribute:: DEFAULT_SCORE :annotation: :float = 3.4 .. py:attribute:: TEMPERATURE_FLOOR :annotation: :float = 1.5 .. py:attribute:: TEST_S3_CALCULATION :annotation: = False .. py:attribute:: JSON_REGRESSION_MODEL .. py:attribute:: MODEL_NUMBER :annotation: :int = 1 .. py:attribute:: DEFAULT_INDUSTRY :annotation: = Others .. py:attribute:: VALUE_TARGET_REFERENCE_INTENSITY_BASE :annotation: = inte .. py:attribute:: SLOPE_MAP .. py:attribute:: VALUE_TARGET_REFERENCE .. py:attribute:: INTENSITY_MAPPINGS .. py:attribute:: intensity_metric_types .. py:attribute:: ABSOLUTE_MAPPINGS .. py:attribute:: TEMPERATURE_RESULTS :annotation: = temperature_results .. py:attribute:: INVESTMENT_VALUE :annotation: = investment_value .. py:attribute:: S3_CATEGORY_MAPPINGS .. py:attribute:: EPSILON :annotation: = 1e-06 .. py:class:: PortfolioCoverageTVPConfig Bases: :py:obj:`PortfolioAggregationConfig` .. py:attribute:: FILE_TARGETS .. py:attribute:: FILE_TARGETS_CUSTOM_PATH .. py:attribute:: USE_LOCAL_CTA :annotation: = False .. py:attribute:: SKIP_CTA_FILE_IF_EXISTS :annotation: = True .. py:attribute:: CTA_FILE_URL :annotation: = https://docs.google.com/spreadsheets/d/e/2PACX-1vTn5UZIBmOxWKNFpmQGWWDczMvdBJ74l2_j0emUH9mxEKylHq... .. py:attribute:: USE_CUSTOM_FILE_TARGETS_PATH :annotation: = False .. py:attribute:: OUTPUT_TARGET_STATUS :annotation: = sbti_target_status .. py:attribute:: OUTPUT_WEIGHTED_TARGET_STATUS :annotation: = weighted_sbti_target_status .. py:attribute:: VALUE_STATUS_SET :annotation: = Targets set .. py:attribute:: VALUE_STATUS_COMMITTED :annotation: = Committed .. py:attribute:: VALUE_STATUS_REMOVED :annotation: = Commitment removed .. py:attribute:: TARGET_SCORE_MAP .. py:attribute:: COL_COMPANY_NAME :annotation: = company_name .. py:attribute:: COL_COMPANY_ISIN :annotation: = isin .. py:attribute:: COL_COMPANY_LEI :annotation: = lei .. py:attribute:: COL_TARGET :annotation: = near_term_status