First set of macro variables

orichters commented 4 months ago

@FlorianLeblancDr and I added a first set of macro variables, still needs a review from @IAMconsortium/common-definitions-macro-economy, but I think let us already check whether we are going in the right direction now.

I tried to use tags as much as possible, but sometimes there is significant overlap between economic sectors used for Value Added, for Trade, for Energy etc., so it might be worth doing a cleanup.

@danielhuppmann: I'm not sure whether the Currency unit tag works like that, but I think it should. Haven't tested. Also unsure whether to use billion USD_2010/yr or billion US$2010/yr

danielhuppmann commented 4 months ago

Sorry, the tags don't work like that, they have to be part of the variable-name - see the documentation here.

About the currency-units, I strongly suggest to move towards SI/ISO-conventions and avoid special characters - this will greatly facilitate automated processing, validation and processing in subsequent applications.

orichters commented 4 months ago

@danielhuppmann. I see, I undid that.

Still, I don't understand the error raised in the checks now. I thought I was using the tags now as intended:

  File "/opt/hostedtoolcache/Python/3.11.8/x64/lib/python3.11/site-packages/nomenclature/code.py", line 44, in from_dict
    raise ValueError(f"Code is not a single name-attributes mapping: {mapping}")
ValueError: Code is not a single name-attributes mapping: {'Food': None, 'description': 'COICOP code CP01 (Food)'}
Error: Process completed with exit code 1.

danielhuppmann commented 4 months ago

The following

  - Food:
    description: COICOP code CP01 (Food)

is interpreted as

{
  "Food": None,
  "description": "COICOP code CP01 (Food)"
}

You have to add two whitespaces before the description such

  - Food:
       description: COICOP code CP01 (Food)

is interpreted as

{
  "Food": {"description": "COICOP code CP01 (Food)"}
}

danielhuppmann commented 4 months ago

🤣

orichters commented 4 months ago

Still, the validation creates errors. My suspicion is that I used tags inside tag definitions and that I'm not allowed to do that.

danielhuppmann commented 4 months ago

Unfortunately, you are correct, it is not (yet?) possible to do nested tagging, but given that these are only four items, it works to include them directly, I guess?

danielhuppmann commented 4 months ago

Also, I see that you used Final Energy as the standard method for aggregating carbon prices. Looking back at https://github.com/IAMconsortium/common-definitions/pull/38, I think we should make that explicit in the variable name how the price was computed.

FlorianLeblancDr commented 4 months ago

I did not find the common suggestion of Tier 1 we build https://github.com/FlorianLeblancDr/common-definitions/blob/for_orichters_macro/definitions/variable/macro-economy/tier_1_macroeconomic.yaml And found it easier to go for smaller PR starting with #57

@IAMconsortium/common-definitions-macro-economy

volker-krey commented 4 months ago

Dear all, @danielhuppmann made me aware of this discussion. Regarding the Value Added variables, I wanted to mention that as part of the AR6 National Scenario call, we revised those variables and actually included ISIC sectors in the definitions to reduce ambiguity and improve consistency with statistical data. Those definitions can be found on the variable_definitions sheet of the national data template (https://data.ene.iiasa.ac.at/ar6-scenario-submission/static/files/national.zip), but let me paste the Value Added variables in below. Hope this is useful.

FlorianLeblancDr commented 4 months ago

Very usefull Volker. We will build on this and make the template consitent with the AR6 national call.

We started to do it in PR57

e.g. This File

I will also mention your comment in the general issue

danielhuppmann commented 2 weeks ago

@orichters, is this PR still relevant?

IAMconsortium / common-definitions

First set of macro variables #56