ITR.configs

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

ColumnsConfig

PortfolioAggregationConfig

TemperatureScoreConfig

This factor determines what part of the temperature for a not SBTi-validated company should be the TS and what part

PortfolioCoverageTVPConfig

class ITR.configs.ColumnsConfig
COMPANY_ID = company_id
COMPANY_ISIN = company_isin
COMPANY_LEI = company_lei
COMPANY_ISIC = isic
TARGET_IDS = target_ids
REGRESSION_PARAM = param
REGRESSION_INTERCEPT = intercept
MARKET_CAP = company_market_cap
INVESTMENT_VALUE = investment_value
COMPANY_ENTERPRISE_VALUE = company_enterprise_value
COMPANY_EV_PLUS_CASH = company_ev_plus_cash
COMPANY_TOTAL_ASSETS = company_total_assets
TARGET_REFERENCE_NUMBER = target_type
SCOPE = scope
SCOPE3_CATEGORY = s3_category
AR6 = ar6
REDUCTION_FROM_BASE_YEAR = reduction_from_base_year
START_YEAR = start_year
VARIABLE = variable
SLOPE = slope
TIME_FRAME = time_frame
MODEL = model
ANNUAL_REDUCTION_RATE = annual_reduction_rate
EMISSIONS_IN_SCOPE = emissions_in_scope
TEMPERATURE_SCORE = temperature_score
COMPANY_NAME = company_name
OWNED_EMISSIONS = owned_emissions
COUNTRY = country
SECTOR = sector
GHG_SCOPE1 = ghg_s1
GHG_SCOPE2 = ghg_s2
GHG_SCOPE12 = ghg_s1s2
GHG_SCOPE3 = ghg_s3
COMPANY_REVENUE = company_revenue
CASH_EQUIVALENTS = company_cash_equivalents
TARGET_CLASSIFICATION = target_classification
REDUCTION_AMBITION = reduction_ambition
BASE_YEAR = base_year
END_YEAR = end_year
SBTI_VALIDATED = sbti_validated
TARGET_CONFIRM_DATE = statement_date
ACHIEVED_EMISSIONS = achieved_reduction
ISIC = isic
INDUSTRY_LVL1 = industry_level_1
INDUSTRY_LVL2 = industry_level_2
INDUSTRY_LVL3 = industry_level_3
INDUSTRY_LVL4 = industry_level_4
COVERAGE_S1 = coverage_s1
COVERAGE_S2 = coverage_s2
COVERAGE_S3 = coverage_s3
INTENSITY_METRIC = intensity_metric
INTENSITY_METRIC_AR6 = intensity_metric
TARGET_TYPE_AR6 = target_type
AR6_VARIABLE = ar6_variable
REGRESSION_MODEL = Regression_model
BASEYEAR_GHG_S1 = base_year_ghg_s1
BASEYEAR_GHG_S2 = base_year_ghg_s2
BASEYEAR_GHG_S1S2 = base_year_ghg_s1s2
BASEYEAR_GHG_S3 = base_year_ghg_s3
REGION = region
ENGAGEMENT_TARGET = engagement_target
BASE_YEAR_TS = base_year_ts
END_YEAR_TS = end_year_ts
TO_CALCULATE = to_calculate
GHG_S3_1 = ghg_s3_1
GHG_S3_2 = ghg_s3_2
GHG_S3_3 = ghg_s3_3
GHG_S3_4 = ghg_s3_4
GHG_S3_5 = ghg_s3_5
GHG_S3_6 = ghg_s3_6
GHG_S3_7 = ghg_s3_7
GHG_S3_8 = ghg_s3_8
GHG_S3_9 = ghg_s3_9
GHG_S3_10 = ghg_s3_10
GHG_S3_11 = ghg_s3_11
GHG_S3_12 = ghg_s3_12
GHG_S3_13 = ghg_s3_13
GHG_S3_14 = ghg_s3_14
GHG_S3_15 = ghg_s3_15
PARAM = param
INTERCEPT = intercept
WEIGHTED_TEMPERATURE_SCORE = weighted_temperature_score
CONTRIBUTION_RELATIVE = contribution_relative
CONTRIBUTION = contribution
class ITR.configs.PortfolioAggregationConfig
COLS
class ITR.configs.TemperatureScoreConfig

Bases: 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.

SBTI_FACTOR = 1
DEFAULT_SCORE :float = 3.4
TEMPERATURE_FLOOR :float = 1.5
TEST_S3_CALCULATION = False
JSON_REGRESSION_MODEL
MODEL_NUMBER :int = 1
DEFAULT_INDUSTRY = Others
VALUE_TARGET_REFERENCE_INTENSITY_BASE = inte
SLOPE_MAP
VALUE_TARGET_REFERENCE
INTENSITY_MAPPINGS
intensity_metric_types
ABSOLUTE_MAPPINGS
TEMPERATURE_RESULTS = temperature_results
INVESTMENT_VALUE = investment_value
S3_CATEGORY_MAPPINGS
EPSILON = 1e-06
class ITR.configs.PortfolioCoverageTVPConfig

Bases: PortfolioAggregationConfig

FILE_TARGETS
FILE_TARGETS_CUSTOM_PATH
USE_LOCAL_CTA = False
SKIP_CTA_FILE_IF_EXISTS = True
CTA_FILE_URL = https://docs.google.com/spreadsheets/d/e/2PACX-1vTn5UZIBmOxWKNFpmQGWWDczMvdBJ74l2_j0emUH9mxEKylHq...
USE_CUSTOM_FILE_TARGETS_PATH = False
OUTPUT_TARGET_STATUS = sbti_target_status
OUTPUT_WEIGHTED_TARGET_STATUS = weighted_sbti_target_status
VALUE_STATUS_SET = Targets set
VALUE_STATUS_COMMITTED = Committed
VALUE_STATUS_REMOVED = Commitment removed
TARGET_SCORE_MAP
COL_COMPANY_NAME = company_name
COL_COMPANY_ISIN = isin
COL_COMPANY_LEI = lei
COL_TARGET = near_term_status