Switch to nomenclature-template structure

.github/workflows/ruff.yml

@@ -0,0 +1,8 @@
+name: Ruff
+on: [ push, pull_request ]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1

.gitignore

@@ -1,3 +1,6 @@
+### Common definitions
+common-definitions/
+
 ### IntelliJ PyCharm ###
 .idea/
 

README.md

@@ -1,8 +1,8 @@
 # Scenario Explorer Workflow Template
 
-Copyright 2022-2023 IIASA
+Copyright 2022-2024 IIASA
 
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Code style: ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 ## Overview
 
@@ -12,6 +12,9 @@ To use this template for a project, do the following:
 - Create a new repository from this template
 - Update the title and overview section of this Readme
 - Start adding definitions and mappings 
+- If you want to use the [common-definitions](https://github.com/IAMconsortium/common-definitions)
+  developed and maintained by the IAMC, rename the file `nomenclature_template.yaml`
+  to `nomenclature.yaml`.
 
 ### Project nomenclature
 

definitions/region/common.yaml

@@ -0,0 +1,2 @@
+- common:
+  - World

definitions/variable/variables.yaml

@@ -0,0 +1,3 @@
+- Emissions|CO2:
+    description: Total net emissions of carbon dioxide (CO2)
+    unit: Mt CO2/yr

nomenclature_template.yaml

@@ -0,0 +1,8 @@
+repositories:
+  common-definitions:
+    url: https://github.com/IAMconsortium/common-definitions.git/
+definitions:
+  variable:
+    repository: common-definitions
+  region:
+    repository: common-definitions

requirements.txt

@@ -1,2 +1,2 @@
-pyam-iamc >= 1.0  # the `pyam` package is released on pypi under this name
-nomenclature-iamc >= 0.11
+pyam-iamc >= 2.1  # the `pyam` package is released on pypi under this name
+nomenclature-iamc >= 0.16