Source for the Cornerstone EEIO model docs, published at TBD.
The site explains the theory, assumptions, data, and validation behind the Cornerstone multi-regional EEIO model, and how to apply its emission factors. It is built with MyST and served by GitHub Pages through the docs hub repo, cornerstone-data/cornerstone-data.github.io.
Requires Node.js 20 or later.
npm install -g mystmd # or: pip install mystmd
myst start # live preview at http://localhost:3000
myst build --html --strict # the same build CI runs- Pull requests are built and previewed at
https://cornerstone-data.github.io/eeio-docs/pr-preview/pr-<number>/, and links are checked. - Merges to
mainare built withBASE_URL=/eeioand pushed into the hub repo'seeio/folder, which GitHub Pages serves within a minute or so.
| Path | Contents |
|---|---|
myst.yml |
Site config, navigation, branding |
intro/, io/, ee/, factors/, validation/, benchmarking/, flag/ |
Site sections |
reference/ |
Glossary, notation, methods by country/version, data sources, further reading |
faq.md |
FAQs |
releases/ |
One page per model release |
versions/ |
Version records (one data file per release) |
figures/ |
Hand-made diagrams, figure generator scripts, figures.csv inventory |
data/ |
Small cached data extracts for figures |
references.bib |
Bibliography; add entries as pages cite them, reusing keys from the papers repo where they exist |
_parts/ |
Navbar, footer, and custom CSS |
See CONTRIBUTING.md for page conventions.