pathfinder_framework.carbon_footprint package

Submodules

pathfinder_framework.carbon_footprint.biogenic_accounting_methodology module

class pathfinder_framework.carbon_footprint.biogenic_accounting_methodology.BiogenicAccountingMethodology(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The standard followed to account for biogenic emissions and removals. If defined, the value MUST be one of the following:

  • PEF: For the EU Product Environmental Footprint Guide

  • ISO: For the ISO 14067 standard

  • GHGP: For the Greenhouse Gas Protocol (GHGP) Land sector and Removals Guidance

  • Quantis: For the Quantis Accounting for Natural Climate Solutions Guidance

The enumeration of standards above will be evolved in future revisions. Account for this when implementing the validation of this property.

For more information, please refer to the official documentation:

https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/#element-attrdef-carbonfootprint-biogenicaccountingmethodology

GHGP = 'GHGP'
ISO = 'ISO'
PEF = 'PEF'
QUANTIS = 'Quantis'

pathfinder_framework.carbon_footprint.carbon_footprint module

pathfinder_framework.carbon_footprint.characterization_factors module

class pathfinder_framework.carbon_footprint.characterization_factors.CharacterizationFactors(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The IPCC version of the GWP characterization factors used in the calculation of the PCF (see Pathfinder Framework Section 3.2.2). The value MUST be one of the following:

  • AR6: for the Sixth Assessment Report of the Intergovernmental Panel on Climate Change (IPCC)

  • AR5: for the Fifth Assessment Report of the IPCC.

The set of characterization factor identifiers will likely change in future revisions. It is recommended to account for this when implementing the validation of this property.

For more information, please refer to the official documentation:

https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/#element-attrdef-carbonfootprint-characterizationfactors

AR5 = 'AR5'
AR6 = 'AR6'

pathfinder_framework.carbon_footprint.cross_sectoral_standard module

class pathfinder_framework.carbon_footprint.cross_sectoral_standard.CrossSectoralStandard(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

CrossSectoralStandard is the enumeration of accounting standards used for product carbon footprint calculation. Valid values are

  • GHG Protocol Product standard: for the GHG Protocol Product standard

  • ISO Standard 14067: for ISO Standard 14067

  • ISO Standard 14044: for ISO Standard 14044

4.9.1. JSON Representation Each CrossSectoralStandard MUST be encoded as a JSON string.

The value of each DeclaredUnit MUST be encoded as a JSON String.

For more information, please refer to the official documentation:

https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/#dt-crosssectoralstandard

GHG_PROTOCOL = 'GHG Protocol Product standard'
ISO_14044 = 'ISO Standard 14044'
ISO_14067 = 'ISO Standard 14067'

pathfinder_framework.carbon_footprint.declared_unit module

class pathfinder_framework.carbon_footprint.declared_unit.DeclaredUnit(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

DeclaredUnit is the enumeration of accepted declared units with values.

The values are based on the International System of Units (SI) as defined by the International Committee for Weights and Measures (ICWM).

  • LITER: for special SI Unit litre

  • KILOGRAM: for SI Base Unit kilogram

  • CUBIC_METER: for cubic meter, the Derived Unit from SI Base Unit metre

  • KILOWATT_HOUR: for kilowatt-hour, the Derived Unit from special SI Unit watt

  • MEGAJOULE: for megajoule, the Derived Unit from special SI Unit joule

  • TON_KILOMETER: for ton kilometer, the Derived Unit from SI Base Units kilogram and metre

  • SQUARE_METER: for square meter, the Derived Unit from SI Base Unit metre

The value of each DeclaredUnit MUST be encoded as a JSON String.

For more information, please refer to the official documentation:

https://wbcsd.github.io/data-exchange-protocol/v2/#dt-declaredunit

And the SI Unit reference:

https://www.bipm.org/documents/20126/41483022/SI-Brochure-9-EN.pdf/2d2b50bf-f2b4-9661-f402-5f9d66e4b507

CUBIC_METER = 'cubic meter'
KILOGRAM = 'kilogram'
KILOWATT_HOUR = 'kilowatt hour'
LITER = 'liter'
MEGAJOULE = 'megajoule'
SQUARE_METER = 'square meter'
TON_KILOMETER = 'ton kilometer'

pathfinder_framework.carbon_footprint.geographical_scope module

pathfinder_framework.carbon_footprint.product_or_sector_specific_rule_operator module

class pathfinder_framework.carbon_footprint.product_or_sector_specific_rule_operator.ProductOrSectorSpecificRuleOperator(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

A ProductOrSectorSpecificRuleOperator is the enumeration of Product Category Rule (PCR) operators. Valid values are:

  • PEF: for EU / PEF Methodology PCRs

  • EPD International: for PCRs authored or published by EPD International

  • OTHER: for a PCR not published by the operators mentioned above

4.13.1. JSON Representation Each value is encoded as a JSON String.

For more information, please refer to the official documentation:

https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/#dt-productorsectorspecificruleoperator

EPD_INTERNATIONAL = 'EPD International'
OTHER = 'Other'
PEF = 'PEF'

pathfinder_framework.carbon_footprint.reference_period module

pathfinder_framework.carbon_footprint.region_or_subregion module

class pathfinder_framework.carbon_footprint.region_or_subregion.RegionOrSubregion(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The RegionOrSubregion data type represents a geographic region or subregion.

It MUST be encoded as a String with value equal to one of the following values:

  • Africa: for the UN geographic region Africa

  • Americas: for the UN geographic region Americas

  • Asia: for the UN geographic region Asia

  • Europe: for the UN geographic region Europe

  • Oceania: for the UN geographic region Oceania

  • Australia and New Zealand: for the UN geographic subregion Australia and New Zealand

  • Central Asia: for the UN geographic subregion Central Asia

  • Eastern Asia: for the UN geographic subregion Eastern Asia

  • Eastern Europe: for the UN geographic subregion Eastern Europe

  • Latin America and the Caribbean: for the UN geographic subregion Latin America and the Caribbean

  • Melanesia: for the UN geographic subregion Melanesia

  • Micronesia: for the UN geographic subregion Micronesia

  • Northern Africa: for the UN geographic subregion Northern Africa

  • Northern America: for the UN geographic subregion Northern America

  • Northern Europe: for the UN geographic subregion Northern Europe

  • Polynesia: for the UN geographic subregion Polynesia

  • South-eastern Asia: for the UN geographic subregion South-eastern Asia

  • Southern Asia: for the UN geographic subregion Southern Asia

  • Southern Europe: for the UN geographic subregion Southern Europe

  • Sub-Saharan Africa: for the UN geographic subregion Sub-Saharan Africa

  • Western Asia: for the UN geographic subregion Western Asia

  • Western Europe: for the UN geographic subregion Western Europe

For more information, please refer to the official documentation:

https://wbcsd.github.io/tr/2023/data-exchange-protocol-20231207/#dt-regionorsubregion

AFRICA = 'Africa'
AMERICAS = 'Americas'
ASIA = 'Asia'
AUSTRALIA_AND_NEW_ZEALAND = 'Australia and New Zealand'
CENTRAL_ASIA = 'Central Asia'
EASTERN_ASIA = 'Eastern Asia'
EASTERN_EUROPE = 'Eastern Europe'
EUROPE = 'Europe'
LATIN_AMERICA_AND_THE_CARIBBEAN = 'Latin America and the Caribbean'
MELANESIA = 'Melanesia'
MICRONESIA = 'Micronesia'
NORTHERN_AFRICA = 'Northern Africa'
NORTHERN_AMERICA = 'Northern America'
NORTHERN_EUROPE = 'Northern Europe'
OCEANIA = 'Oceania'
POLYNESIA = 'Polynesia'
SOUTHERN_ASIA = 'Southern Asia'
SOUTHERN_EUROPE = 'Southern Europe'
SOUTH_EASTERN_ASIA = 'South-eastern Asia'
SUB_SAHARAN_AFRICA = 'Sub-Saharan Africa'
WESTERN_ASIA = 'Western Asia'
WESTERN_EUROPE = 'Western Europe'

Module contents