Skip to content

docs(validation): validation and QA page - #28

Merged
WesIngwersen merged 18 commits into
mainfrom
validation-page
Oct 26, 2026
Merged

WesIngwersen merged 18 commits into
mainfrom
validation-page

Conversation

@WesIngwersen

Copy link
Copy Markdown
Member

Closes #12. Stacked on #25.

Writes validation/index.md in three parts:

  1. Code validation: unit, schema, integration/regression tests against the pinned release build, CI checks.
  2. Data validation: on arrival, through each transformation (totals kept, balancing, GHGRP floor, invalid values), against references and other years, gaps.
  3. Model validation: recalculating national emissions (diag(D) × L × y vs source data and vs B × q), U.S. table checks, comparison with previous models, published-file checks.

Adds figures/diagrams/quality-pipeline.svg.

🤖 Generated with Claude Code

@github-actions

github-actions Bot commented Oct 26, 2026 •

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-10-26 16:57 UTC

@Yohanna1906

Copy link
Copy Markdown
Contributor

@WesIngwersen question on terminology: should we call Tier 3 "proxy tables" instead of "templates"? I changed it on io/country-tiers.md (Tier 3 heading, table, and prose) but left other pages (e.g. ee/country-tiers.md, reference/methods-by-country.md, the glossary, the FAQ, and the tier map) saying "template" until we decide.

@bl-young bl-young left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - some minor phrasing suggestions.

Comment thread validation/index.md Outdated
Comment thread validation/index.md Outdated
Comment thread validation/index.md Outdated
Comment thread validation/index.md Outdated
### Against references and other years

- **Other years of the same data.** Each data update is compared with the previous year of the same source: sector counts, totals and the sectors that move most. Over the U.S. time series from 2017 to 2024, changes in emissions are checked against changes in output, sector by sector.
- **Other sources.** The model's U.S. emissions by sector are compared with facility totals from GHGRP. Where two sources cover the same countries, as FIGARO and the OECD tables do for 45 countries, they are compared sector by sector before one is chosen (see [](../reference/methods-by-country.md)).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Where two sources cover the same countries, as FIGARO and the OECD tables do for 45 countries, they are compared sector by sector before one is chosen" Is this fully accurate?

Comment thread validation/index.md Outdated
Comment thread validation/index.md Outdated
Comment thread validation/index.md Outdated
Comment thread validation/index.md Outdated
Comment thread validation/index.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would that footnote about benchmarking be better off just in the figure caption? right now it kind of gives the vibes of double caption

Base automatically changed from ef-docs-refactor to main October 26, 2026 16:42
WesIngwersen and others added 6 commits October 26, 2026 12:42
Code, data and model validation, with a quality pipeline diagram.
Based on the tests, CI, balance and diagnostics in the model code.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Describes the open-source bedrock pipeline (U.S. components) and the
currently closed-source ceda pipeline (global MRIO and emission factors).
Validation now links to it instead of calling all code open source.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
WesIngwersen and others added 12 commits October 26, 2026 12:44
Co-authored-by: Ben Young (ERG) <44471635+bl-young@users.noreply.github.com>
Co-authored-by: Ben Young (ERG) <44471635+bl-young@users.noreply.github.com>
Co-authored-by: Ben Young (ERG) <44471635+bl-young@users.noreply.github.com>
Co-authored-by: Ben Young (ERG) <44471635+bl-young@users.noreply.github.com>
Co-authored-by: Ben Young (ERG) <44471635+bl-young@users.noreply.github.com>
Co-authored-by: Ben Young (ERG) <44471635+bl-young@users.noreply.github.com>
Co-authored-by: Ben Young (ERG) <44471635+bl-young@users.noreply.github.com>
Co-authored-by: Ben Young (ERG) <44471635+bl-young@users.noreply.github.com>
Applies the proxy-table naming from io/country-tiers.md to the EE tier page,
reference table, glossary, FAQ, IO overview and tier map. Syncs the Japan
GHG source in country_tiers.csv with the reference page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…tion

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@WesIngwersen
WesIngwersen merged commit 475b165 into main Oct 26, 2026
1 of 2 checks passed
@WesIngwersen
WesIngwersen deleted the validation-page branch October 26, 2026 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Validation/QA page

3 participants