diff --git a/.github/rulesets/gitflow-main.overlay.json b/.github/rulesets/gitflow-main.overlay.json
index 7d55c8cd..e34527f9 100644
--- a/.github/rulesets/gitflow-main.overlay.json
+++ b/.github/rulesets/gitflow-main.overlay.json
@@ -16,10 +16,6 @@
"context": "Formatting / Run Prettier Check",
"integration_id": 15368
},
- {
- "context": "JSON Schema / Check Schema Docs",
- "integration_id": 15368
- },
{
"context": "JSON Schema / Run JSON validator",
"integration_id": 15368
diff --git a/.github/rulesets/gitflow-production.overlay.json b/.github/rulesets/gitflow-production.overlay.json
index 8b10478e..bc7d9167 100644
--- a/.github/rulesets/gitflow-production.overlay.json
+++ b/.github/rulesets/gitflow-production.overlay.json
@@ -21,10 +21,6 @@
"context": "Formatting / Run Prettier Check",
"integration_id": 15368
},
- {
- "context": "JSON Schema / Check Schema Docs",
- "integration_id": 15368
- },
{
"context": "JSON Schema / Run JSON validator",
"integration_id": 15368
diff --git a/.github/workflows/node-json-schema.yml b/.github/workflows/node-json-schema.yml
index 47a57e64..79cc7ad8 100644
--- a/.github/workflows/node-json-schema.yml
+++ b/.github/workflows/node-json-schema.yml
@@ -42,42 +42,6 @@ jobs:
VITE_INCLUDE_INVALID: ${{ steps.set-include.outputs.vite-include-invalid }}
run: npm run schema:check
- schema-docs:
- name: "Check Schema Docs"
- runs-on: ubuntu-latest
-
- steps:
- - name: Checkout code
- uses: actions/checkout@v7
-
- - name: Setup Node.js
- uses: actions/setup-node@v7
- with:
- node-version-file: .nvmrc
- cache: "npm"
- cache-dependency-path: package-lock.json
-
- - name: Install dependencies
- run: npm ci
-
- - name: Run JSON schema render
- run: npm run schema:generate:docs
-
- - name: Compare Results
- run: |
- git add --all
- changes=$(git diff-index HEAD --name-only -- $OUTPUTS)
- if [ -n "$changes" ]; then
- echo "Changes found after documenting."
- echo "$changes"
- echo "Please update documentation."
- git --no-pager diff HEAD
- exit 1
- else
- echo "No changes found after documenting."
- exit 0
- fi
-
types-check:
name: "Check generated types"
runs-on: ubuntu-latest
diff --git a/.gitignore b/.gitignore
index d8125a30..a09ba3fd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -24,8 +24,5 @@ yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
-# Python venv
-.venv/
-
# Generated/copied files
public/data/**/*
diff --git a/.prettierignore b/.prettierignore
index b7826205..1521c8b7 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -1,3 +1 @@
-.venv
dist
-public/schema.html
diff --git a/README.md b/README.md
index 390baafb..6dfb7b77 100644
--- a/README.md
+++ b/README.md
@@ -111,14 +111,6 @@ npm run lint:fix
npm run format
```
-## Documentation
-
-### JSON Schema
-
-To render JSON Schema documentation (available in-app at `/schema.html` route), run `npm run docs:json:schema`, which invokes the `scripts/generate-schema-docs.sh`. This script creates and activates a python virtual environment, and renders the `public/schema.html` file, which will be picked up by the build process.
-
-There is a GitHub workflow (`schema-docs` in `.github/workflows/node-json-schema.yml`) to check that the documentation and the schema do not diverge.
-
## Releases
This project uses [`semantic-release`](https://semantic-release.gitbook.io/semantic-release) to manage release versions.
diff --git a/package.json b/package.json
index 974e9152..8aaaf71e 100644
--- a/package.json
+++ b/package.json
@@ -22,8 +22,7 @@
"schema:check": "npx ts-node --esm scripts/schema-check-files.ts src/data testdata/valid",
"schema:check:srcdata": "npx ts-node --esm scripts/schema-check-files.ts src/data",
"schema:check:testdata": "npx ts-node --esm scripts/schema-check-files.ts testdata/valid",
- "schema:generate": "npm run schema:generate:types && npm run schema:generate:docs",
- "schema:generate:docs": "scripts/generate-schema-docs.sh",
+ "schema:generate": "npm run schema:generate:types",
"schema:generate:types": "npx ts-node --esm scripts/generate-types.ts && prettier --write \"src/types/**/*.d.ts\"",
"test": "vitest run",
"test:watch": "vitest"
diff --git a/public/schema/countryCode.v1.html b/public/schema/countryCode.v1.html
deleted file mode 100644
index d17906a3..00000000
--- a/public/schema/countryCode.v1.html
+++ /dev/null
@@ -1,430 +0,0 @@
-
-
-
- Country Code
-
-
-
-
- Expand all
-
-
- Collapse all
-
-
-
-
- Country Code
-
- A single ISO-3166-1 alpha-2 country code (e.g., US, DE). Only 2-letter
- codes are accepted; do not use full country names or 3-letter codes.
- 2-letter strings that do not map to a country (e.g., EU) will throw
- downstream errors.
-
-
-
Must not be:
-
-
-
-
Type: string
-
Must match regular expression: ^[A-Za-z]{3}$
-
-
-
Must match regular expression: ^(?!\s*$).+
-
- Examples:
- Emissions Scope
-
-
-
-
- Expand all
-
-
- Collapse all
-
-
-
-
- Emissions Scope
- Type: enum (of string)
- Defines which greenhouse gases are covered in the pathway's modeled
- emissions.
-
-
-
Must be one of:
-
- "No information"
- "CO2"
- "CO2e (Kyoto)"
- "CO2e (CO2, Methane)"
- "CO2e (unspecified GHGs)"
- "Other emissions scope"
-
-
Geography
-
-
-
-
- Expand all
-
-
- Collapse all
-
-
-
-
- Geography
- Type: object
- Geographical coverage of a pathway. 'global' marks whole-world coverage
- (a literal flag, not a list of every country); 'regions' maps an
- author-defined region label, kept as named in the source publication, to
- the ISO-3166-1 alpha-2 country codes it contains (member arrays may be
- empty when the publication provides no mapping); 'country' lists
- standalone ISO-3166-1 alpha-2 country codes.
-
- No Additional Properties
-
-
-
-
-
-
-
-
-
Type: boolean
-
True if the pathway covers the entire world.
-
-
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Map from an author-defined region label (as named in the
- publication) to the ISO-3166-1 alpha-2 country codes in that
- region. Member arrays may be empty when the publication does not
- provide a mapping.
-
-
-
-
-
-
-
-
-
-
- Each additional property must conform to the following
- schema
-
-
-
-
Type: array
-
-
- All items must be unique
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Country Code
-
Type: enum (of string)
-
- A single ISO-3166-1 alpha-2 country code (e.g., US,
- DE). Only 2-letter codes are accepted; do not use
- full country names or 3-letter codes. 2-letter
- strings that do not map to a country (e.g., EU) will
- throw downstream errors.
-
-
-
-
-
Must not be:
-
-
-
-
Type: string
-
Must match regular expression:
- ^[A-Za-z]{3}$
-
-
-
-
-
Must match regular expression:
- ^(?!\s*$).+
-
-
-
Examples:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: array
-
- Standalone ISO-3166-1 alpha-2 country codes covered by the
- pathway.
-
-
-
-
- All items must be unique
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Country Code
-
Type: enum (of string)
-
- A single ISO-3166-1 alpha-2 country code (e.g., US, DE).
- Only 2-letter codes are accepted; do not use full country
- names or 3-letter codes. 2-letter strings that do not map to
- a country (e.g., EU) will throw downstream errors.
-
-
-
-
-
Must not be:
-
-
-
-
Type: string
-
Must match regular expression:
- ^[A-Za-z]{3}$
-
-
-
-
-
Must match regular expression: ^(?!\s*$).+
-
-
-
Examples:
-
-
-
-
-
-
-
-
-
-
-
-
Geography Item
-
-
-
-
- Expand all
-
-
- Collapse all
-
-
-
-
- Geography Item
-
- A single geography identifier used across schemas. Accepts 'Global',
- ISO-3166-1 alpha-2 country codes (e.g., 'US', 'DE'), or a set of region
- names (e.g., 'East Asia and Pacific', 'North America'). Any 2-letter
- items in the array will be treated as an ISO code. Any 2-letter entries
- that do not map to a country will throw errors (EU). Do not use full
- country names, only ISO alpha-2 codes. To avoid typographical errors,
- items may not be 3 letters long (USA)
-
-
-
- All of
-
-
-
-
-
-
Type: object
-
Must match regular expression: ^(?!\s*$).+
-
-
-
-
-
-
Must not be:
-
-
-
-
Type: object
-
Must match regular expression:
- ^[A-Za-z]{3}$
-
-
-
-
-
-
Examples:
-
-
-
"Europe and Central Asia"
-
-
-
Label
-
-
-
-
- Expand all
-
-
- Collapse all
-
-
-
-
- Label
- Type: object Label object with optional abbreviation.
- No Additional Properties
-
-
-
-
-
-
-
-
-
Type: string
-
Full name or label
-
-
- Must be at most 200 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Short name, acronym, or abbreviation
-
-
-
- Must be at most 20 characters long
-
-
-
-
-
Metric
-
-
-
-
- Expand all
-
-
- Collapse all
-
-
-
-
- Metric
- Type: object Common definition of a metric used across pathway schemas.
- No Additional Properties
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
Display name of the metric
-
-
-
Must be one of:
-
- "Emissions Intensity"
- "Capacity"
- "Generation"
- "Technology Mix"
- "Absolute Emissions"
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
- Specifies which parts of the sector value chain the metric
- applies to.
-
-
-
-
- Must be at most 1000 characters long
-
-
-
-
-
Pathway Metadata
-
-
-
-
- Expand all
-
-
- Collapse all
-
-
-
-
- Pathway Metadata
- Type: object A schema for the pathway metadata dataset in TPR.
- No Additional Properties
-
-
-
-
-
-
-
-
-
Type: string
-
- URI of the schema that validates this document (see
- https://json-schema.org/).
-
-
-
-
- Must be at most 1000 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
The unique identifier for a pathway.
-
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Label
-
Type: object
-
Name of the pathway.
-
-
No Additional Properties
-
-
-
-
-
-
-
-
-
Type: string
-
Full name or label
-
-
- Must be at most 200 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Short name, acronym, or abbreviation
-
-
-
- Must be at most 20 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Brief description of the pathway.
Must match regular expression: \.$
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Publication
-
Type: object
-
Bibliographic information about the report or dataset.
-
-
-
No Additional Properties
-
-
-
-
-
-
-
-
-
Type: object
-
Title of the report or publication.
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Optional subtitle of the publication.
-
-
-
- Must be at most 300 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: array of string
-
List of authors or contributors.
-
-
-
- All items must be unique
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: string
-
-
- Must be at most 100 characters
- long
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Publisher or organization responsible for the
- publication.
-
-
-
-
-
- All of
-
-
-
-
-
-
Type: object
-
- 😅 ERROR in schema generation, a referenced schema
- could not be loaded, no documentation here
- unfortunately 🏜️
-
-
-
-
-
-
-
-
- One of
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "ASEAN Centre for Energy"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "ACE"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Indonesia Just Energy Transition
- Partnership Secretariat"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "JETP ID"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Center for Global Sustainability
- and Institute for Essential Services
- Reform"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "CGS, IESR"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Electricity and Renewable Energy
- Authority in Viet Nam, Danish Energy
- Agency"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "VN EREA, DEA"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "European Commission, Joint
- Research Centre"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "JRC"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Institute for Sustainable Futures,
- University of Technology
- Sydney"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "UTS ISF"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "International Energy Agency"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "IEA"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Network of Central Banks and
- Supervisors for Greening the
- Financial System"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "NGFS"
-
-
-
-
-
-
-
-
-
-
Must not be:
-
-
-
-
Type: object
-
-
-
- The following properties are required:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Philippines Department of
- Energy"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Sustainable Development Solutions
- Network and ClimateWorks
- Centre"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "UN SDSN, CW"
-
-
-
-
-
-
-
-
-
-
Must not be:
-
-
-
-
Type: object
-
-
-
- The following properties are required:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "TransitionZero"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
Allowed full publisher names.
-
-
-
-
Must be one of:
-
-
- "ASEAN Centre for Energy"
-
-
- "Indonesia Just Energy Transition
- Partnership Secretariat"
-
-
- "Center for Global Sustainability and
- Institute for Essential Services Reform"
-
-
- "Electricity and Renewable Energy
- Authority in Viet Nam, Danish Energy
- Agency"
-
-
- "European Commission, Joint Research
- Centre"
-
-
- "Institute for Sustainable Futures,
- University of Technology Sydney"
-
-
- "International Energy Agency"
-
-
- "Network of Central Banks and
- Supervisors for Greening the Financial
- System"
-
-
- "Philippines Department of Energy"
-
-
- "Sustainable Development Solutions
- Network and ClimateWorks Centre"
-
-
- "TransitionZero"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Allowed short publisher names or acronyms.
-
-
-
-
-
Must be one of:
-
-
- "ACE"
-
-
- "IEA"
-
-
- "CGS, IESR"
-
-
- "JETP ID"
-
-
- "JRC"
-
-
- "NGFS"
-
-
- "UN SDSN, CW"
-
-
- "UTS ISF"
-
-
- "VN EREA, DEA"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Year of publication.
-
-
-
- Value must be greater or equal to 1900 and
- lesser or equal to 2100
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Month of publication (1–12).
-
-
-
- Value must be greater or equal to 1 and
- lesser or equal to 12
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Day of publication (1–31).
-
-
-
- Value must be greater or equal to 1 and
- lesser or equal to 31
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
City where the publication was published.
-
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
- Digital Object Identifier for the publication.
-
Must match regular expression:
- ^10\.[^\s/]+/.+$
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
International Standard Book Number, if applicable.
-
-
-
- Must be at most 32 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
- International Standard Serial Number, if applicable.
-
Must match regular expression:
- ^[0-9]{4}-[0-9]{3}[0-9X]$
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
License under which the document is published
-
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: array of object
-
- Links to related materials such as data, supplementary
- files, or the full report.
-
-
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: object
-
No Additional Properties
-
-
-
-
-
-
-
-
-
Type: string
-
Short label for the linked resource.
-
-
-
- Must be at most 100 characters
- long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
URL to the linked resource.
Must match regular expression:
- ^(https?|ftp):\/\/[^\s/$.?#].[^\s]*$
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
Type of the pathway pathway.
-
-
-
Must be one of:
-
- "Normative"
- "Exploratory"
- "Predictive"
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
- Year by which net zero is reached in the pathway. If Pathway
- does not reach net zero, this field should be omitted.
-
-
-
-
- Value must be greater or equal to 2030 and lesser
- or equal to 2100
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Year from which the model starts.
-
-
-
- Value must be greater or equal to 1900 and lesser
- or equal to 2030
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Year in which the model ends.
-
-
-
- Value must be greater or equal to 2030 and lesser
- or equal to 2100
-
-
-
-
-
-
-
-
-
-
-
-
Type: number
-
- Modeled temperature increase expected by the pathway (in degrees
- Celsius).
-
-
-
-
- Value must be greater or equal to 0.5 and lesser
- or equal to 3 and a multiple of
- 0.1
-
-
-
-
-
-
-
-
-
-
-
-
Geography
-
Type: object
-
Geographical areas that the pathway covers.
-
-
-
No Additional Properties
-
-
-
-
-
-
-
-
-
Type: boolean
-
True if the pathway covers the entire world.
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Map from an author-defined region label (as named in the
- publication) to the ISO-3166-1 alpha-2 country codes in
- that region. Member arrays may be empty when the
- publication does not provide a mapping.
-
-
-
-
-
-
-
-
-
-
- Each additional property must conform to the
- following schema
-
-
-
-
Type: array
-
-
- All items must be unique
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: object
-
- 😅 ERROR in schema generation, a referenced
- schema could not be loaded, no documentation
- here unfortunately 🏜️
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: array
-
- Standalone ISO-3166-1 alpha-2 country codes covered by
- the pathway.
-
-
-
-
- All items must be unique
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: object
-
- 😅 ERROR in schema generation, a referenced schema
- could not be loaded, no documentation here
- unfortunately 🏜️
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: array of object
-
Sectors that the pathway covers.
-
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: object
-
No Additional Properties
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
Display name of a sector.
-
-
-
-
Must be one of:
-
-
- "Land Use"
-
-
- "Agriculture"
-
-
- "Buildings"
-
- "Steel"
- "Cement"
-
- "Chemicals"
-
-
- "Coal Mining"
-
-
- "Oil (Upstream)"
-
-
- "Gas (Upstream)"
-
- "Power"
-
- "Automotive"
-
-
- "Aviation"
-
- "Rail"
-
- "Shipping"
-
- "Other"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: array
-
Technologies applicable to this sector.
-
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: enum (of string)
-
- Display name of the technology as presented in
- charts or tables.
-
-
-
-
-
Must be one of:
-
-
- "Precision Agriculture"
-
-
- "Agroforestry"
-
-
- "Bioenergy Crops"
-
-
- "Energy Efficiency"
-
-
- "Smart Grids"
-
-
- "Renewable Heating"
-
-
- "Heat Pumps"
-
-
- "Building Automation"
-
-
- "Smart Appliances"
-
-
- "Insulation"
-
-
- "Carbon Capture and Storage"
-
-
- "Electrification"
-
-
- "Process Optimization"
-
-
- "Hydrogen Use"
-
-
- "Coal"
-
- "Oil"
- "Gas"
-
- "Wind"
-
-
- "Solar"
-
-
- "Nuclear"
-
-
- "Biomass"
-
-
- "Hydro"
-
-
- "Renewables"
-
-
- "Electric Vehicles"
-
-
- "Hydrogen Vehicles"
-
-
- "Biofuels"
-
-
- "Public Transport"
-
-
- "Active Mobility"
-
-
- "Aviation Efficiency"
-
-
- "Maritime Efficiency"
-
-
- "Other"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Overview of the pathway.
Must match regular expression: \.$
-
-
- Must be at most 1000 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Expert recommendation for the pathway.
Must match regular expression: \.$
-
-
- Must be at most 10000 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Type: array
-
-
- All items must be unique
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: enum (of string)
-
Display name of the metric
-
-
-
-
Must be one of:
-
-
- "Emissions Intensity"
-
- "Capacity"
- "Generation"
- "Technology Mix"
-
- "Absolute Emissions"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: object
-
Key features of the pathway.
-
-
No Additional Properties
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Describes the overall trend of greenhouse gas emissions
- over time, from continued growth to rapid decline.
-
-
-
-
Must be one of:
-
-
- "No information"
-
-
- "Significant increase"
-
-
- "Moderate increase"
-
-
- "Minor increase"
-
-
- "Low or no change"
-
-
- "Minor decrease"
-
-
- "Moderate decrease"
-
-
- "Significant decrease"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Indicates how efficiently energy is used to produce
- economic output across the sectors covered in the
- pathway.
-
-
-
-
Must be one of:
-
-
- "No information"
-
-
- "Significant deterioration"
-
-
- "Moderate deterioration"
-
-
- "Minor deterioration"
-
-
- "Low or no change"
-
-
- "Minor improvement"
-
-
- "Moderate improvement"
-
-
- "Significant improvement"
-
-
-
-
-
-
-
-
-
-
-
-
- energyDemand
- Required
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Captures the change in total energy consumption, driven
- by factors such as socio-economic development,
- technology shifts and consumer behavior.
-
-
-
-
Must be one of:
-
-
- "No information"
-
-
- "Significant decrease"
-
-
- "Moderate decrease"
-
-
- "Minor decrease"
-
-
- "Low or no change"
-
-
- "Minor increase"
-
-
- "Moderate increase"
-
-
- "Significant increase"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Represents the extent to which energy end-uses
- transition from fossil fuels to electricity.
-
-
-
-
Must be one of:
-
-
- "No information"
-
-
- "Significant decrease"
-
-
- "Moderate decrease"
-
-
- "Minor decrease"
-
-
- "Low or no change"
-
-
- "Minor increase"
-
-
- "Moderate increase"
-
-
- "Significant increase"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: array of enum (of string)
-
- Identifies the types of policies modeled as drivers of
- the pathway, such as carbon pricing, subsidies, or
- mandated phaseouts of specific technologies.
-
-
-
-
- Must contain a minimum of 1 items
-
-
- All items must be unique
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: enum (of string)
-
-
Must be one of:
-
-
- "Carbon price"
-
-
- "Feed-in tariffs"
-
-
- "Performance standards"
-
-
- "Phaseout dates"
-
-
- "Subsidies"
-
-
- "Target technology shares"
-
- "Other"
- "None"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Describes how technology costs evolve over time, from
- static cost assumptions to rapidly declining costs
- (e.g., via learning curves).
-
-
-
-
Must be one of:
-
-
- "No information"
-
- "Increase"
-
- "Low or no change"
-
- "Decrease"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Emissions Scope
-
Type: enum (of string)
-
- Defines which greenhouse gases are covered in the
- pathway's modeled emissions.
-
-
-
-
-
Must be one of:
-
-
- "No information"
-
- "CO2"
-
- "CO2e (Kyoto)"
-
-
- "CO2e (CO2, Methane)"
-
-
- "CO2e (unspecified GHGs)"
-
-
- "Other emissions scope"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Represents the overall stringency and intent of modeled
- policies relative to climate targets, often reflecting
- if and how far the included policies go beyond currently
- legislated ones
-
-
-
-
Must be one of:
-
-
- "No information"
-
-
- "No policies included"
-
-
- "Current/legislated policies"
-
-
- "Current and drafted policies"
-
-
- "NDCs, unconditional only"
-
-
- "NDCs incl. conditional targets"
-
-
- "High ambition policies"
-
-
- "Other policy ambition"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Specifies the level of granularity in cost data, such as
- total system costs or detailed CAPEX/OPEX breakdowns.
-
-
-
-
Must be one of:
-
-
- "No information"
-
- "Total costs"
-
- "Capital costs, O&M, etc."
-
-
- "Other cost breakdown"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: array of enum (of string)
-
- Lists emerging or breakthrough technologies that are
- explicitly modeled within the pathway. These are
- considered in technology deployment too.
-
-
-
-
- Must contain a minimum of 1 items
-
-
- All items must be unique
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: enum (of string)
-
-
Must be one of:
-
-
- "No information"
-
-
- "No new technologies"
-
- "CCUS"
- "DAC"
-
- "Green H2/ammonia"
-
- "SAF"
-
- "Battery storage"
-
- "EGS/AGS"
-
- "Other new technologies"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Summarizes how investment requirements are quantified,
- from total system to sector-level or supply-chain
- detail.
-
-
-
-
Must be one of:
-
-
- "No information"
-
-
- "Total investment"
-
- "By sector"
-
- "By sector, part of value chain"
-
-
- "By technology"
-
-
- "By tech, part of value chain"
-
-
-
-
-
-
-
-
-
-
-
Pathway Timeseries
-
-
-
-
- Expand all
-
-
- Collapse all
-
-
-
-
- Pathway Timeseries
- Type: object A schema for the pathway timeseries dataset in TPR.
- No Additional Properties
-
-
-
-
-
-
-
-
-
Type: string
-
- URI of the schema that validates this document (see
- https://json-schema.org/).
-
-
-
-
- Must be at most 1000 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
The unique identifier for a pathway.
-
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Type: array of string
-
Identifiers of the associated pathways.
-
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: string
-
-
- Must be at least 1 characters long
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Name of the timeseries.
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Brief description of the timeseries.
Must match regular expression: \.$
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Publication
-
Type: object
-
Bibliographic information about the report or dataset.
-
-
-
No Additional Properties
-
-
-
-
-
-
-
-
-
Type: object
-
Title of the report or publication.
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Optional subtitle of the publication.
-
-
-
- Must be at most 300 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: array of string
-
List of authors or contributors.
-
-
-
- All items must be unique
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: string
-
-
- Must be at most 100 characters
- long
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Publisher or organization responsible for the
- publication.
-
-
-
-
-
- All of
-
-
-
-
-
-
Type: object
-
- 😅 ERROR in schema generation, a referenced schema
- could not be loaded, no documentation here
- unfortunately 🏜️
-
-
-
-
-
-
-
-
- One of
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "ASEAN Centre for Energy"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "ACE"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Indonesia Just Energy Transition
- Partnership Secretariat"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "JETP ID"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Center for Global Sustainability
- and Institute for Essential Services
- Reform"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "CGS, IESR"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Electricity and Renewable Energy
- Authority in Viet Nam, Danish Energy
- Agency"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "VN EREA, DEA"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "European Commission, Joint
- Research Centre"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "JRC"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Institute for Sustainable Futures,
- University of Technology
- Sydney"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "UTS ISF"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "International Energy Agency"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "IEA"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Network of Central Banks and
- Supervisors for Greening the
- Financial System"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "NGFS"
-
-
-
-
-
-
-
-
-
-
Must not be:
-
-
-
-
Type: object
-
-
-
- The following properties are required:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Philippines Department of
- Energy"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Sustainable Development Solutions
- Network and ClimateWorks
- Centre"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "UN SDSN, CW"
-
-
-
-
-
-
-
-
-
-
Must not be:
-
-
-
-
Type: object
-
-
-
- The following properties are required:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "TransitionZero"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
Allowed full publisher names.
-
-
-
-
Must be one of:
-
-
- "ASEAN Centre for Energy"
-
-
- "Indonesia Just Energy Transition
- Partnership Secretariat"
-
-
- "Center for Global Sustainability and
- Institute for Essential Services Reform"
-
-
- "Electricity and Renewable Energy
- Authority in Viet Nam, Danish Energy
- Agency"
-
-
- "European Commission, Joint Research
- Centre"
-
-
- "Institute for Sustainable Futures,
- University of Technology Sydney"
-
-
- "International Energy Agency"
-
-
- "Network of Central Banks and
- Supervisors for Greening the Financial
- System"
-
-
- "Philippines Department of Energy"
-
-
- "Sustainable Development Solutions
- Network and ClimateWorks Centre"
-
-
- "TransitionZero"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Allowed short publisher names or acronyms.
-
-
-
-
-
Must be one of:
-
-
- "ACE"
-
-
- "IEA"
-
-
- "CGS, IESR"
-
-
- "JETP ID"
-
-
- "JRC"
-
-
- "NGFS"
-
-
- "UN SDSN, CW"
-
-
- "UTS ISF"
-
-
- "VN EREA, DEA"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Year of publication.
-
-
-
- Value must be greater or equal to 1900 and
- lesser or equal to 2100
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Month of publication (1–12).
-
-
-
- Value must be greater or equal to 1 and
- lesser or equal to 12
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Day of publication (1–31).
-
-
-
- Value must be greater or equal to 1 and
- lesser or equal to 31
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
City where the publication was published.
-
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
- Digital Object Identifier for the publication.
-
Must match regular expression:
- ^10\.[^\s/]+/.+$
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
International Standard Book Number, if applicable.
-
-
-
- Must be at most 32 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
- International Standard Serial Number, if applicable.
-
Must match regular expression:
- ^[0-9]{4}-[0-9]{3}[0-9X]$
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
License under which the document is published
-
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: array of object
-
- Links to related materials such as data, supplementary
- files, or the full report.
-
-
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: object
-
No Additional Properties
-
-
-
-
-
-
-
-
-
Type: string
-
Short label for the linked resource.
-
-
-
- Must be at most 100 characters
- long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
URL to the linked resource.
Must match regular expression:
- ^(https?|ftp):\/\/[^\s/$.?#].[^\s]*$
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Name of the associated pathway.
-
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Emissions Scope
-
Type: enum (of string)
-
- Defines which greenhouse gases are covered in the pathway's
- modeled emissions.
-
-
-
-
-
Must be one of:
-
- "No information"
- "CO2"
- "CO2e (Kyoto)"
- "CO2e (CO2, Methane)"
-
- "CO2e (unspecified GHGs)"
-
-
- "Other emissions scope"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: array of object
-
- Array of yearly data points for each sector, technology, and
- metric defined in this timeseries.
-
-
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
-
No Additional Properties
-
-
- All of
-
-
-
-
-
-
Type: object
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected, then
- the conditions in the "Then" tab should be respected.
- Otherwise, the conditions in the "Else" tab should be
- respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "emissionsIntensity"
-
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: number
-
-
- Value must be greater or equal to
- -2 and lesser or equal to
- 2
-
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected, then
- the conditions in the "Then" tab should be respected.
- Otherwise, the conditions in the "Else" tab should be
- respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "capacity"
-
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: number
-
-
- Value must be greater or equal to
- 0
-
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected, then
- the conditions in the "Then" tab should be respected.
- Otherwise, the conditions in the "Else" tab should be
- respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "generation"
-
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: number
-
-
- Value must be greater or equal to
- 0
-
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected, then
- the conditions in the "Then" tab should be respected.
- Otherwise, the conditions in the "Else" tab should be
- respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "technologyMix"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "%"
-
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: number
-
-
- Value must be greater or equal to
- 0 and lesser or equal to
- 100
-
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected, then
- the conditions in the "Then" tab should be respected.
- Otherwise, the conditions in the "Else" tab should be
- respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "absoluteEmissions"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "MtCO2e"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "Global"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "power"
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
-
- Value must be lesser or equal to
- 2023
-
-
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: number
-
-
- Value must be lesser or equal to
- 20000
-
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected, then
- the conditions in the "Then" tab should be respected.
- Otherwise, the conditions in the "Else" tab should be
- respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "absoluteEmissions"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "MtCO2e"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "Global"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "power"
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
-
- Value must be greater or equal to
- 2024
-
-
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: number
-
-
- Value must be lesser or equal to
- 30000
-
-
-
-
-
-
-
-
-
-
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected, then the
- conditions in the "Then" tab should be respected. Otherwise,
- the conditions in the "Else" tab should be respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "power"
-
-
-
-
-
-
-
-
-
-
-
- All of
-
-
-
-
-
-
Type: object
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected,
- then the conditions in the "Then" tab should be
- respected. Otherwise, the conditions in the "Else"
- tab should be respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "emissionsIntensity"
-
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "tCO2e/MWh"
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected,
- then the conditions in the "Then" tab should be
- respected. Otherwise, the conditions in the "Else"
- tab should be respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "absoluteEmissions"
-
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "MtCO2e"
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected,
- then the conditions in the "Then" tab should be
- respected. Otherwise, the conditions in the "Else"
- tab should be respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "capacity"
-
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "GW"
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected,
- then the conditions in the "Then" tab should be
- respected. Otherwise, the conditions in the "Else"
- tab should be respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "generation"
-
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "TWh"
-
-
-
-
-
-
-
-
-
-
Type: object
-
- Conditional Subschema
-
-
- If the conditions in the "If" tab are respected,
- then the conditions in the "Then" tab should be
- respected. Otherwise, the conditions in the "Else"
- tab should be respected.
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "technologyMix"
-
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "%"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of null or string)
-
-
Must be one of:
-
-
- "coal"
-
- "oil"
- "gas"
-
- "nuclear"
-
-
- "hydro"
-
-
- "wind"
-
-
- "solar"
-
-
- "biomass"
-
-
- "geothermal"
-
-
- "hydrogen"
-
-
- "renewables"
-
-
- "battery"
-
-
- "other"
-
- null
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
-
Must be one of:
-
-
- "emissionsIntensity"
-
-
- "absoluteEmissions"
-
-
- "capacity"
-
-
- "generation"
-
-
- "technologyMix"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Calendar year of the data point.
-
-
-
- Value must be greater or equal to
- 1900 and lesser or equal to
- 2100
-
-
-
-
-
-
-
-
-
-
-
-
-
Geography Item
-
Type: enum (of string)
-
- Geographical area that the data covers. This should
- be a single string value: either 'Global', a country
- ISO-3166-1 alpha-2 code (e.g., 'US', 'DE'), or a
- free-text region name (e.g., 'North America', 'South
- East Asia'). Only 2-letter codes are accepted for
- countries; do not use full country names or 3-letter
- codes (e.g., 'USA' is not allowed). If a 2-letter
- code does not map to a country (e.g., 'EU'), it will
- result in an error.
-
-
-
-
-
- All of
-
-
-
-
-
-
Type: object
-
Must match regular expression:
- ^(?!\s*$).+
-
-
-
-
-
-
Must not be:
-
-
-
-
Type: object
-
Must match regular expression:
- ^[A-Za-z]{3}$
-
-
-
-
-
-
-
-
-
-
Examples:
-
-
-
-
-
-
"Europe and Central Asia"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Sector to which this data point belongs (must match
- one of the defined sectors).
-
-
-
-
Must be one of:
-
- "landUse"
-
- "agriculture"
-
-
- "buildings"
-
-
- "industry"
-
- "steel"
- "cement"
-
- "chemicals"
-
-
- "coalMining"
-
-
- "oilUpstream"
-
-
- "gasUpstream"
-
- "power"
-
- "automotive"
-
-
- "transport"
-
-
- "roadtransport"
-
-
- "aviation"
-
- "rail"
-
- "shipping"
-
- "other"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of null or string)
-
- Technology represented in this record (e.g., Solar,
- Wind, or null if sector-level only).
-
-
-
-
Must be one of:
-
-
- "precisionAgriculture"
-
-
- "agroforestry"
-
-
- "bioenergyCrops"
-
-
- "energyEfficiency"
-
-
- "smartGrids"
-
-
- "renewableHeating"
-
-
- "heatPumps"
-
-
- "buildingAutomation"
-
-
- "smartAppliances"
-
-
- "insulation"
-
-
- "carbonCaptureandStorage"
-
-
- "electrification"
-
-
- "processOptimization"
-
-
- "hydrogenUse"
-
- "coal"
- "oil"
- "gas"
- "wind"
- "solar"
- "nuclear"
- "biomass"
- "hydro"
-
- "renewables"
-
-
- "electricVehicles"
-
-
- "hydrogenVehicles"
-
-
- "biofuels"
-
-
- "publicTransport"
-
-
- "activeMobility"
-
-
- "aviationEfficiency"
-
-
- "maritimeEfficiency"
-
- "other"
- null
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Metric reported for this record (e.g., Capacity,
- Generation, Emissions Intensity).
-
-
-
-
Must be one of:
-
-
- "emissionsIntensity"
-
-
- "capacity"
-
-
- "generation"
-
-
- "technologyMix"
-
-
- "absoluteEmissions"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: number
-
- Numeric value of the metric for the given year,
- sector, and technology.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Measurement unit associated with the metric value
- (e.g., GW, TWh, tCO2e).
-
-
-
-
Must be one of:
-
-
- "tCO2e/MWh"
-
- "MtCO2e"
- "GW"
- "TWh"
- "%"
-
-
-
-
-
-
-
-
-
-
-
-
Publication
-
-
-
-
- Expand all
-
-
- Collapse all
-
-
-
-
- Publication
- Type: object Bibliographic information about the report or dataset.
- No Additional Properties
-
-
-
-
-
-
-
-
-
Label
-
Type: object
-
Title of the report or publication.
-
-
-
No Additional Properties
-
-
-
-
-
-
-
-
-
Type: string
-
Full name or label
-
-
- Must be at most 200 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Short name, acronym, or abbreviation
-
-
-
- Must be at most 20 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Optional subtitle of the publication.
-
-
-
- Must be at most 300 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Type: array of string
-
List of authors or contributors.
-
-
-
- All items must be unique
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: string
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: object
-
Publisher or organization responsible for the publication.
-
-
-
-
- All of
-
-
-
-
-
-
Label
-
Type: object
-
Label object with optional abbreviation.
Same definition as title
-
-
-
-
-
-
- One of
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "ASEAN Centre for Energy"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "ACE"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Indonesia Just Energy Transition
- Partnership Secretariat"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "JETP ID"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Center for Global Sustainability and
- Institute for Essential Services
- Reform"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "CGS, IESR"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Electricity and Renewable Energy Authority
- in Viet Nam, Danish Energy Agency"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "VN EREA, DEA"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "European Commission, Joint Research
- Centre"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "JRC"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Institute for Sustainable Futures,
- University of Technology Sydney"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "UTS ISF"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "International Energy Agency"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "IEA"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Network of Central Banks and Supervisors
- for Greening the Financial System"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value: "NGFS"
-
-
-
-
-
-
-
-
-
-
Must not be:
-
-
-
-
Type: object
-
-
-
The following properties are required:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Philippines Department of Energy"
-
-
-
-
-
-
-
-
Type: object
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "Sustainable Development Solutions Network
- and ClimateWorks Centre"
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "UN SDSN, CW"
-
-
-
-
-
-
-
-
-
-
Must not be:
-
-
-
-
Type: object
-
-
-
The following properties are required:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: const
-
Specific value:
- "TransitionZero"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
Allowed full publisher names.
-
-
-
-
Must be one of:
-
-
- "ASEAN Centre for Energy"
-
-
- "Indonesia Just Energy Transition Partnership
- Secretariat"
-
-
- "Center for Global Sustainability and Institute
- for Essential Services Reform"
-
-
- "Electricity and Renewable Energy Authority in
- Viet Nam, Danish Energy Agency"
-
-
- "European Commission, Joint Research Centre"
-
-
- "Institute for Sustainable Futures, University
- of Technology Sydney"
-
-
- "International Energy Agency"
-
-
- "Network of Central Banks and Supervisors for
- Greening the Financial System"
-
-
- "Philippines Department of Energy"
-
-
- "Sustainable Development Solutions Network and
- ClimateWorks Centre"
-
-
- "TransitionZero"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
Allowed short publisher names or acronyms.
-
-
-
-
Must be one of:
-
- "ACE"
- "IEA"
-
- "CGS, IESR"
-
-
- "JETP ID"
-
- "JRC"
- "NGFS"
-
- "UN SDSN, CW"
-
-
- "UTS ISF"
-
-
- "VN EREA, DEA"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Year of publication.
-
-
- Value must be greater or equal to 1900 and lesser
- or equal to 2100
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Month of publication (1–12).
-
-
-
- Value must be greater or equal to 1 and lesser or
- equal to 12
-
-
-
-
-
-
-
-
-
-
-
-
Type: integer
-
Day of publication (1–31).
-
-
- Value must be greater or equal to 1 and lesser or
- equal to 31
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
City where the publication was published.
-
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
Digital Object Identifier for the publication.
Must match regular expression:
- ^10\.[^\s/]+/.+$
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
International Standard Book Number, if applicable.
-
-
-
- Must be at most 32 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
- International Standard Serial Number, if applicable.
-
Must match regular expression:
- ^[0-9]{4}-[0-9]{3}[0-9X]$
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
License under which the document is published
-
-
-
- Must be at most 100 characters long
-
-
-
-
-
-
-
-
-
-
-
-
Type: array of object
-
- Links to related materials such as data, supplementary files, or
- the full report.
-
-
-
-
No Additional Items
-
Each item of this array must be:
-
-
-
-
Type: object
-
No Additional Properties
-
-
-
-
-
-
-
-
-
Type: string
-
Short label for the linked resource.
-
-
-
- Must be at most 100 characters
- long
-
-
-
-
-
-
-
-
-
-
-
-
-
Type: string
-
URL to the linked resource.
Must match regular expression:
- ^(https?|ftp):\/\/[^\s/$.?#].[^\s]*$
-
-
-
-
-
-
-
-
-
-
Sector
-
-
-
-
- Expand all
-
-
- Collapse all
-
-
-
-
- Sector
- Type: object Common definition of a sector used across pathway schemata.
- No Additional Properties
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
Display name of a sector.
-
-
-
Must be one of:
-
- "Land Use"
- "Agriculture"
- "Buildings"
- "Steel"
- "Cement"
- "Chemicals"
- "Coal Mining"
- "Oil (Upstream)"
- "Gas (Upstream)"
- "Power"
- "Automotive"
- "Aviation"
- "Rail"
- "Shipping"
- "Other"
-
-
-
-
-
-
Technology
-
-
-
-
- Expand all
-
-
- Collapse all
-
-
-
-
- Technology
- Type: object Technologies for sectors
No Additional Properties
-
-
-
-
-
-
-
-
-
Type: enum (of string)
-
- Display name of the technology as presented in charts or tables.
-
-
-
-
-
Must be one of:
-
-
- "Precision Agriculture"
-
- "Agroforestry"
- "Bioenergy Crops"
- "Energy Efficiency"
- "Smart Grids"
- "Renewable Heating"
- "Heat Pumps"
- "Building Automation"
- "Smart Appliances"
- "Insulation"
-
- "Carbon Capture and Storage"
-
- "Electrification"
-
- "Process Optimization"
-
- "Hydrogen Use"
- "Coal"
- "Oil"
- "Gas"
- "Wind"
- "Solar"
- "Nuclear"
- "Biomass"
- "Hydro"
- "Renewables"
- "Electric Vehicles"
- "Hydrogen Vehicles"
- "Biofuels"
- "Public Transport"
- "Active Mobility"
- "Aviation Efficiency"
- "Maritime Efficiency"
- "Other"
-
-
-
-
-
-
/ in the temp copy
-# (safe for docs—does not touch your real source files)
-if command -v gsed >/dev/null 2>&1; then SED=gsed; else SED=sed; fi
-$SED -i'' -e "s#\"http://pathways.rmi.org/schema/#\"$FILE_BASE#g" $(find "$TMP_DIR" -type f -name '*.json')
-
-
-generate-schema-doc \
- --config-file "scripts/schema-render-config.json" \
- "$TMP_DIR" \
- "public/schema/"
-
-prettier --write "public/schema/"
-
-# leave the venv
-deactivate
-
-# cleanup temp copy
-rm -rf "$TMP_DIR"
diff --git a/scripts/generate-types.ts b/scripts/generate-types.ts
index 461dbc8d..6d913d60 100644
--- a/scripts/generate-types.ts
+++ b/scripts/generate-types.ts
@@ -1,8 +1,8 @@
/**
- * Generate *.d.ts files from JSON Schemas in public/schema/
+ * Generate *.d.ts files from JSON Schemas in src/schema/
*
* Example:
- * public/schema/pathwayMetadata.v1.json → src/types/pathwayMetadata.v1.d.ts
+ * src/schema/pathwayMetadata.v1.json → src/types/pathwayMetadata.v1.d.ts
* → Root interface name: PathwayMetadataV1
*/
import path from "node:path";
diff --git a/scripts/schema-render-config.json b/scripts/schema-render-config.json
deleted file mode 100644
index eaeb38ca..00000000
--- a/scripts/schema-render-config.json
+++ /dev/null
@@ -1,14 +0,0 @@
-{
- "expand_buttons": true,
- "footer_show_time": false,
- "minify": true,
- "show_breadcrumbs": true,
- "show_toc": false,
- "template_name": "js",
- "with_footer": true,
- "template_md_options": {
- "badge_as_image": true,
- "show_heading_numbers": true,
- "show_array_restrictions": true
- }
-}