Skip to content

fix: adopt v5.5 result metadata and register missing result groups (#392)#405

Open
parthdagia05 wants to merge 1 commit intoEAPD-DRB:mainfrom
parthdagia05:feature/392-result-metadata
Open

fix: adopt v5.5 result metadata and register missing result groups (#392)#405
parthdagia05 wants to merge 1 commit intoEAPD-DRB:mainfrom
parthdagia05:feature/392-result-metadata

Conversation

@parthdagia05
Copy link
Copy Markdown

Align result metadata with upstream MUIO v5.5

Align result metadata with upstream MUIO v5.5 as the authoritative source.


Variables.json fixes

  • OV, NONTU, UDCI_d, UDCE_d

    • Filled empty unitRule values with correct definitions
  • TEP

    • Changed CapUnitIdmilion Currency
    • Reason: cost variable, not capacity
  • AEL_d

    • Changed EmiUnitmilion Currency / EmiUnit
    • Reason: shadow price requires composite unit
  • EB_d

    • Changed CapUnitIdmilion Currency / EmiUnit
    • Renamed to "Energy Balance"
  • ROA

    • Added /years divisor to represent rate
  • ROPBT, ROUBT

    • Added /years divisor to represent rate units

Const.Class.js updates

Added missing result groups so they are accessible in Pivot UI:

  • Added to:

    • RESULTGROUPNAMES
    • RESULTPARAMORDER
    • RESULTPARAMCOLORS
  • New groups:

    • R → Objective Value
    • RYC → Commodity shadow prices
    • RYCn → Constraint shadow prices

Linked issue


Existing related work reviewed


Overlap assessment

  • Classification: No overlap
  • Overlapping items: None

Reason:
No existing PR addresses:

  • Incorrect unit rules in Variables.json
  • Missing R, RYC, RYCn registrations

Why this PR should proceed

  • Shadow prices (AEL_d, EB_d, UDCI_d, UDCE_d)

    • Currently display incorrect or blank units
  • TEP

    • Displays capacity units instead of currency
  • Rate variables (ROA, ROPBT, ROUBT)

    • Missing /years, leading to incorrect interpretation
  • Result groups (R, RYC, RYCn)

    • Not visible in Pivot UI despite valid data

Summary

  • What changed:

    • Fixed 10 incorrect/empty unit rules in Variables.json
    • Added 3 missing result groups in Const.Class.js
  • Why:

    • MUIOGO must align with upstream MUIO v5.5 metadata
    • Ensures correct interpretation of:
      • Shadow prices
      • Cost variables
      • Rate variables

Validation

  • Tests added/updated (not applicable)
  • Validation steps documented
  • Evidence attached

Validation steps

  1. Load the app → open Pivot results page
  2. Verify:
    • TEP and NONTU show correct units under RYT
  3. Navigate to:
    • RYC, RYE, RYCn groups via selector
  4. Confirm:
    • Objective Value (R) shows unit = number
  5. Verify:
    • ROA, ROPBT, ROUBT include /years in units

Documentation

  • Docs updated (not applicable - metadata change only)
  • No setup/workflow changes required

Scope check

  • No unrelated refactors
  • Feature branch used
  • No dependency on upstream OSeMOSYS/MUIO
  • Base: EAPD-DRB/MUIOGO:main

Exception rationale

…PD-DRB#392)

Align result metadata with upstream MUIO v5.5 as the authoritative source.

Variables.json fixes:
- OV, NONTU, UDCI_d, UDCE_d: fill empty unit rules with correct values
- TEP: CapUnitId → milion Currency (cost variable, not capacity)
- AEL_d: EmiUnit → milion Currency / EmiUnit (shadow price composite unit)
- EB_d: CapUnitId → milion Currency / EmiUnit, rename to "Energy Balance"
- ROA: add /years divisor for rate unit
- ROPBT, ROUBT: add /years divisor for rate units

Const.Class.js:
- Add R, RYC, RYCn to RESULTGROUPNAMES, RESULTPARAMORDER,
  and RESULTPARAMCOLORS so the pivot UI can navigate to Objective
  Value, commodity shadow prices, and constraint shadow prices.
@parthdagia05
Copy link
Copy Markdown
Author

@SeaCelo this PR is ready for a review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task] Fix result metadata and shadow-price rendering from MUIO v5.5

1 participant