From 964a4da05634dab0acab66cb921d9bbd1851d443 Mon Sep 17 00:00:00 2001
From: Daniel Huppmann <dh@dergelbesalon.at>
Date: Thu, 28 Nov 2024 05:47:33 +0100
Subject: [PATCH] Use latest common-definitions and add European regions (#1)

---
 definitions/region/european-countries.yaml    | 49 +++++++++++++++++++
 definitions/region/european-regions.yaml      | 35 +++++++++++++
 definitions/variable/.gitkeep                 |  0
 definitions/variable/variables.yaml           | 10 ++--
 ...clature_template.yaml => nomenclature.yaml | 10 ++--
 requirements.txt                              |  2 +-
 6 files changed, 99 insertions(+), 7 deletions(-)
 create mode 100644 definitions/region/european-countries.yaml
 create mode 100644 definitions/region/european-regions.yaml
 delete mode 100644 definitions/variable/.gitkeep
 rename nomenclature_template.yaml => nomenclature.yaml (50%)

diff --git a/definitions/region/european-countries.yaml b/definitions/region/european-countries.yaml
new file mode 100644
index 0000000..6103ca4
--- /dev/null
+++ b/definitions/region/european-countries.yaml
@@ -0,0 +1,49 @@
+# This file was created using the script `data/write-countries.py`
+# DO NOT ALTER THIS FILE MANUALLY!
+
+# List of countries
+- Countries:
+  - Albania
+  - Austria
+  - Belarus
+  - Belgium
+  - Bosnia and Herzegovina
+  - Bulgaria
+  - Croatia
+  - Cyprus
+  - Czechia
+  - Denmark
+  - Estonia
+  - Finland
+  - France
+  - Germany
+  - Greece
+  - Hungary
+  - Iceland
+  - Ireland
+  - Italy
+  - Kosovo
+  - Latvia
+  - Liechtenstein
+  - Lithuania
+  - Luxembourg
+  - Malta
+  - Moldova
+  - Monaco
+  - Montenegro
+  - Netherlands
+  - North Macedonia
+  - Norway
+  - Poland
+  - Portugal
+  - Romania
+  - Russian Federation
+  - Serbia
+  - Slovakia
+  - Slovenia
+  - Spain
+  - Sweden
+  - Switzerland
+  - Turkey
+  - Ukraine
+  - United Kingdom
diff --git a/definitions/region/european-regions.yaml b/definitions/region/european-regions.yaml
new file mode 100644
index 0000000..786767b
--- /dev/null
+++ b/definitions/region/european-regions.yaml
@@ -0,0 +1,35 @@
+- European Regions:
+
+  # generic definitions of Europe
+  - Europe (excl. Turkey)
+  - Europe (incl. Turkey)
+
+  # definitions of European regions and groups of countries
+  - EU27 & UK:
+      description: European Union and the United Kingdom (formerly EU28)
+      countries: [
+        Austria, Belgium, Bulgaria, Croatia, Cyprus, Czechia, Denmark, Estonia, Finland,
+        France, Germany, Greece, Hungary, Ireland, Italy, Latvia, Lithuania, Luxembourg,
+        Malta, Netherlands, Poland, Portugal, Romania, Slovakia, Slovenia, Spain,
+        Sweden, United Kingdom
+      ]
+  - EU27:
+      countries: [
+        Austria, Belgium, Bulgaria, Croatia, Cyprus, Czechia, Denmark, Estonia, Finland,
+        France, Germany, Greece, Hungary, Ireland, Italy, Latvia, Lithuania, Luxembourg,
+        Malta, Netherlands, Poland, Portugal, Romania, Slovakia, Slovenia, Spain, Sweden
+      ]
+  - EU27 (excl. Malta & Cyprus):
+      countries: [
+        Austria, Belgium, Bulgaria, Croatia, Czechia, Denmark, Estonia, Finland, France,
+        Germany, Greece, Hungary, Ireland, Italy, Latvia, Lithuania, Luxembourg,
+        Netherlands, Poland, Portugal, Romania, Slovakia, Slovenia, Spain, Sweden
+      ]
+  - EFTA:
+      description: European Free Trade Association
+      countries: [Iceland, Liechtenstein, Norway, Switzerland]
+      source: https://en.wikipedia.org/wiki/European_Free_Trade_Association
+  - Non-EU-Balkans:
+      countries: [
+        Albania, Bosnia and Herzegovina, Montenegro, North Macedonia, Serbia, Kosovo
+      ]
diff --git a/definitions/variable/.gitkeep b/definitions/variable/.gitkeep
deleted file mode 100644
index e69de29..0000000
diff --git a/definitions/variable/variables.yaml b/definitions/variable/variables.yaml
index e422375..3a23a19 100644
--- a/definitions/variable/variables.yaml
+++ b/definitions/variable/variables.yaml
@@ -1,3 +1,7 @@
-- Emissions|CO2:
-    description: Total net emissions of carbon dioxide (CO2)
-    unit: Mt CO2/yr
+# This file provides variables with different units compared to "common-definitions"
+- Price|Carbon:
+    description: Price of carbon
+    unit: EUR_2020/t CO2
+    tier: 1
+    drop_negative_weights: false
+    weight: Emissions|CO2
diff --git a/nomenclature_template.yaml b/nomenclature.yaml
similarity index 50%
rename from nomenclature_template.yaml
rename to nomenclature.yaml
index c344d80..61cdc76 100644
--- a/nomenclature_template.yaml
+++ b/nomenclature.yaml
@@ -1,8 +1,12 @@
+dimensions:
+  - variable
+  - region
 repositories:
   common-definitions:
     url: https://github.com/IAMconsortium/common-definitions.git/
 definitions:
   variable:
-    repository: common-definitions
-  region:
-    repository: common-definitions
+    repository:
+      name: common-definitions
+      exclude:
+        - name: Price|Carbon
diff --git a/requirements.txt b/requirements.txt
index 8c35dd7..b68f94b 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,2 +1,2 @@
 pyam-iamc >= 2.1  # the `pyam` package is released on pypi under this name
-nomenclature-iamc >= 0.16
+nomenclature-iamc >= 0.21