User Guide¶
Workflows¶
| Workflow | Notebook | Description |
|---|---|---|
| country-fair-shares | 301_custom_fair_share_allocation.ipynb |
Country-level allocations with pipeline |
| iamc-regional-fair-shares | 401_custom_iamc_allocation.ipynb |
IAMC model region allocations |
Both workflows produce relative shares (0-1) and absolute emissions (Mt CO2e).
Outputs & Provenance¶
All outputs include full parameter provenance for reproducibility:
| Output Type | Description | Format |
|---|---|---|
| Relative shares | Country fractions summing to 1.0 | Parquet, CSV |
| Absolute emissions | Shares x global target in physical units | Parquet, CSV |
| Comparison tables | Results across multiple approaches/parameters | CSV (wide) |
| Parameter manifest | All parameter combinations used | CSV |
Parquet files contain complete metadata:
- Every parameter value (weights, years, functional forms)
- Data source identifiers (
emissions-source,gdp-source,population-source, etc.) - Approach names and configuration
This enables exact reproduction and comparison of results. See Output Schema for full column documentation.
Configuration¶
Data sources are configured in conf/data_sources/.
| Data Type | Options |
|---|---|
| Target | rcbs, ar6, rcb-pathways |
| Emissions | e.g. PRIMAP-hist |
| Population | UN/OWID |
| GDP | World Bank WDI |
| Gini | UNU-WIDER |
All bundled data is permissively licensed (CC-BY-4.0 or similar). See Data Sources & Licensing for attribution requirements.
Target Sources¶
fair-shares currently supports three target sources:
| Target | Type | Allocation Functions | Use When | Output |
|---|---|---|---|---|
rcbs |
Budget | Budget approaches | Calculating cumulative national budget allocations | Single value per country |
ar6 |
Pathway | Pathway approaches | Allocating annual emissions following scenario pathways (e.g. AR6) | Time series of annual values |
rcb-pathways |
Hybrid | Pathway approaches | Using budget data but need year-by-year pathways | Budget to global pathway to allocated annually |
rcb-pathways workflow: First converts a global remaining carbon budget into a global annual emission pathway (using exponential decay), then allocates that pathway among countries using pathway allocation functions. See Other Operations for details on pathway generation.
Choosing an Approach¶
Two questions:
- Budget or pathway? Do you need a single cumulative target or year-by-year emissions?
- Which principles? Equal entitlements, historical responsibility (cumulative emissions), capability (ability to pay) -- or some combination? Note: "subsistence protection" as a live approach choice has diminished operational value — Shue later acknowledged that what the poor need is energy, not emissions rights. The more relevant operational concept is the GDR development threshold [Baer 2013] (note: GDR was designed for burden-sharing; fair-shares adapts its capability metric for entitlement allocation), which exempts individuals below a development income threshold (~$8,500 PPP) from capability calculations.
Then:
- Approach Catalog -- all 10 approaches at a glance
- Principle-to-Code -- how principles map to parameters
- Allocation Approaches -- design and parameter details