Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ADR0028: deprecation of property characterizationFactors ; addition of new property characterizationFactorsSources #46

Merged
merged 17 commits into from
Mar 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
86cf047
feat: new backwards-compatible proposal
zeitgeist Jan 16, 2024
defa180
feat: propose change to the technical specifications according to cur…
raimundo-henriques Dec 21, 2023
7279ba2
feat: update proposal following cross-functional discussion
raimundo-henriques Jan 11, 2024
cb82b72
chore: update ADR number
raimundo-henriques Jan 11, 2024
2d3157d
fix: typo and improve advisement
raimundo-henriques Jan 15, 2024
fcfef6f
fix: typo: characterizationFactorsSources should be an array
raimundo-henriques Jan 15, 2024
dbea6d7
chore: minor addition to the ADR
zeitgeist Jan 16, 2024
3ce878a
chore: fix linking issues
zeitgeist Jan 16, 2024
617dc42
feat: include mention of GWP100 in characterizationFactorsSource defi…
raimundo-henriques Jan 23, 2024
d26418c
feat: improve characterizationFactorsSources definition
raimundo-henriques Jan 31, 2024
1bb74ca
feat: add advisement to characterizationFactorsSources and small fixes
raimundo-henriques Jan 31, 2024
11f438a
feat: update deprecated characterizationFactors definition
raimundo-henriques Jan 31, 2024
04ba350
feat: simplify data types for (w/ @zeitgeist)
raimundo-henriques Feb 7, 2024
848fe95
fix: newline issue and missing links to data type
raimundo-henriques Feb 14, 2024
0a1f1d2
feat: small changes to ADR text based on feedback
raimundo-henriques Feb 19, 2024
18d9516
feat: replace characterizationFactorsSources by ippcCharacterizationF…
raimundo-henriques Mar 6, 2024
c1a6762
feat: update version and changelog
raimundo-henriques Mar 13, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions decisions/log/0028-provide-clarity-on-characterization-factors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 28. Provide Clarity on Characterization Factors (AR5 and AR6)

Date: 2024-01-16

## Status

Accepted

## Context

`characterizationFactors` is a mandatory property of the `CarbonFootprint` data type.
It's data type is `String` and the value MUST be one of the following (see [4.2.2 Properties #characterizationFactors](https://wbcsd.github.io/tr/data-exchange-protocol/#element-attrdef-carbonfootprint-characterizationfactors)):
- AR6
- for the Sixth Assessment Report of the Intergovernmental Panel on Climate Change (IPCC)
- AR5
- for the Fifth Assessment Report of the IPCC

However, some PCFs might be calculated with inputs that use both AR5 and AR6 as these can come from
different sources (i.e., different actors in the supply chain). Since the IPCC will keep publishing reports (at an expected cadence of at least 5 years between reports), this problem tends to get worse in the future.

In the context of the Methodology Working Group, PACT members have expressed a very strong
preference for having the possibility of including more than one characterization factor per PCF.

## Decision

1. Change the definition of the `characterizationFactors` from:
> 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: [...]

to (roughly):
> **Deprecated**
>
> The IPCC version of the GWP characterization factors used **in the calculation of the largest relative share of the PCF** (see [=Pathfinder Framework=] Section 3.2.2). The value MUST be one of the following: [...]
>
> [...]
>
> **Advisement: This property is deprecated and only kept to ensure backwards-compatibility. It does not replace the (also mandatory) property `characterizationFactorsSources`.**

(Please refer to the proposed changes to the technical specification for a more detailed and complete diff.)

2. Add the new mandatory property `ipccCharacterizationFactorsSources` defined as a non-empty `Array` of `Strings` with the format `AR$VERSION$`, where `$VERSION$` stands for the IPCC report version number and MUST be an integer.

### Rationale

This proposal aims at providing a forward-looking change on characterization factors while preserving backwards-compatibility.

Backwards-compatibility is preserved by keeping the `characterizationFactors` property (despite its becoming deprecated).

It is forward-looking because future adaptations are unlikely to break backwards-compatibility. If a more fine-grained account of characterization factors use is ever desired, it can be included through optional properties of `CharacterizationFactorsSource`. If ever other sources become relevant (e.g., for specific industries) this too can be acommodated without the need for a breaking change.

## Consequences

1. This ADR introduces a minor change: since the `characterizationFactors` property is maintained, it is backwards compatible.
2. Accordingly, the Technical Specifications version number must be updated from 2.1.x to 2.2.0.
3. Host systems need to validate the new property `ipccCharacterizationFactorsSources` depending on the value of ProductFootprint's property `specsVersion`
28 changes: 24 additions & 4 deletions spec/v2/index.bs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<pre class='metadata'>
Title: Technical Specifications for PCF Data Exchange
Text Macro: VERSION 2.1.1-wip
Text Macro: VERSION 2.2.0-20240312
Shortname: data-exchange-protocol
Level: 1
Status: LD
Expand Down Expand Up @@ -493,14 +493,28 @@ Advisement:
<td>String
<td>M
<td>
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:

Advisement: This property is DEPRECATED and only kept to ensure backwards-compatibility. It will be removed in version 3 of these Technical Specifications. It does not replace the (also mandatory) property <{CarbonFootprint/ipccCharacterizationFactorsSources}>.

The IPCC version of the GWP characterization factors used in the calculation of the PCF (see [=Pathfinder Framework=] Section 3.2.2). In case several characterization factors are used, indicate the earliest version used in your calculations, disregarding supplier provided PCFs. The value MUST be one of the following:
bhadley marked this conversation as resolved.
Show resolved Hide resolved

: `AR6`
:: for the Sixth Assessment Report of the Intergovernmental Panel on Climate Change (IPCC)
: `AR5`
:: for the Fifth Assessment Report of the IPCC.
<tr>
<td><dfn>ipccCharacterizationFactorsSources</dfn>
<td>Array of Strings
<td>M
<td>The characterization factors from one or more IPCC Assessment Reports used in the calculation of the PCF (see [=Pathfinder Framework=] Section 3.2.2).
It MUST be a non-empty set of strings with the format `AR$VERSION$`, where `$VERSION$` stands for the
IPCC report version number and MUST be an integer.

Example values:
<div class=example>["AR6"]</div>
<div class=example>["AR5", "AR6"]</div>

Advisement: 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.
Advisement: Per the Framework, the latest available characterization factor version shall be used, i.e., `["AR6"]`. In the event this is not possible, include the set of all characterization factors used.
<tr>
<td><dfn>crossSectoralStandardsUsed</dfn> : [=CrossSectoralStandardSet=]
<td>Array
Expand Down Expand Up @@ -1382,7 +1396,6 @@ Example JSON string value:
```
</div>


# Product Footprint Lifecycle # {#lifecycle}

## Introduction ## {#lifecycle-intro}
Expand Down Expand Up @@ -2290,6 +2303,13 @@ path: LICENSE.md

# Appendix B: Changelog # {#changelog}

## Version 2.2.0-20240312 (Mar 12, 2024) ## {#changelog-2.2.0-20240312}

Summary of changes:

1. deprecation of the <{CarbonFootprint/characterizationFactors}> property
2. addition of a new <{CarbonFootprint/ipccCharacterizationFactorsSources}> property

## Version 2.1.0 (Dec 07, 2023) ## {#changelog-2.1.0}

This version introduces additional mandatory functionality:
Expand Down