Skip to content

docs: technical docs vs user guide; EF calculation and margin EF pages - #25

Open
WesIngwersen wants to merge 2 commits into
historyfrom
ef-docs-refactor
Open

WesIngwersen wants to merge 2 commits into
historyfrom
ef-docs-refactor

Conversation

@WesIngwersen

@WesIngwersen WesIngwersen commented Oct 25, 2026 •

Copy link
Copy Markdown
Member

Stacked on #24 (history); GitHub will retarget to main when #24 merges.

These revisions set a clear tech docs path AND a user guide path (see the new main page now where the cards are colored and grouped for technical documentation vs user guide). This greatly simplifies the left menu which was getting very longer by putting all the technical docs in a menu.

Refactors

  • Model vs data product. Home page, Release details, rc.1 note and FAQ now state that Cornerstone EEIO 2026 was developed to produce cradle-to-gate emission factors, which are the primary data product. rc.1 = spend-based GHG emission factors; 2026-v1 = time series plus model matrices (format TBD). 2026-v0.1 renamed to 2026-v1.
  • Two tracks. TOC grouped into Technical documentation (IO model, GHG extension, emission factor calculation, validation, benchmarking, release details) and User guide (what's in a release, user guidance, FAQs). Home page cards colored by track (brand blue / amber).

New pages

  • factors/calculation.md — from B and L to PRO/PUR factors: M = B × L, N = C × M, Tier 3, regional and global averages, zero filling, re-pricing 2025/2026 with the BEA gross output price index, φ = 1 / (1 + Σ A_margin).
  • factors/margins.md — margin emission factor formula, margin sectors, re-pricing, published columns, when to use them, mapping to USEEIO SEF with/without margins.

Content is based on the ceda publish code (publish/emission_factors/: dollar_year.py, margins.py, regions.py, table.py).

🤖 Generated with Claude Code

…gin pages

- Frame the emission factors as the primary data product of the 2026
  release; rc.1 publishes the spend-based GHG factors and 2026-v1 adds the
  time series and model matrices (format TBD).
- Reorganize the TOC and home page into a technical documentation track
  and a user guide track, with colored cards for each.
- Add "Calculating the emission factors": M = B x L, N = C x M, Tier 3,
  regional/global averages, zero filling, price-year re-pricing with the
  BEA gross output price index, and the producer-to-purchaser conversion.
- Add "Margin emission factors": formula, margin sectors, re-pricing,
  published columns and when to use them.
- Add A_margin, phi and PI to the notation page and a glossary term;
  fix the glossary statement that factors are only at purchaser price.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 25, 2026 •

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://cornerstone-data.github.io/eeio-docs/pr-preview/pr-25/

Built to branch gh-pages at 2026-10-26 00:10 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@WesIngwersen
WesIngwersen added this pull request to stack #26 October 25, 2026 23:46
GWPs are applied inline as emissions enter the model (ceda
_apply_gwp_conversion_to_ceds_ghg_data; bedrock B is kg CO2e/USD and
derive_C_usa is a row-summer), so B and E are in CO2e by gas, D is B
summed over gases and N = D x L (= M summed over gases).

- Notation: drop C; E, B, M in kg CO2e; D and N redefined.
- GHG extension, intro primer and diagrams updated to match.
- Calculation page: total factors in one step from D/B and L.
- Drop the product-tax statements from the purchaser-price section;
  taxes less subsidies are already in the producer price.

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

This branch has not been deployed

No deployments
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.

1 participant