Skip to content

refactor reporting functions - #2084

Merged
fbenke-pik merged 9 commits into
remindmodel:developfrom
fbenke-pik:reporting
Apr 25, 2025
Merged

refactor reporting functions#2084
fbenke-pik merged 9 commits into
remindmodel:developfrom
fbenke-pik:reporting

Conversation

@fbenke-pik

@fbenke-pik fbenke-pik commented Apr 9, 2025

Copy link
Copy Markdown
Contributor

Purpose of this PR

Previously, data generated by madrat was added as data to the library for some enhanced reporting in reportEmi and reportCrossVariables. This PR introduces a new approach where the data is generated as part of inputdata generation and moved to the output folder when starting a run. The reporting function convGDX2MIF gets the path to that folder passed via the new extraData argument to access the additional reporting data.

The new approach ensures compatibility of the extra data with mrremind and avoids putting madrat generated data under version control in remind2.

Corresponding remind2 PR: pik-piam/remind2#723

  • adjust REMIND config to inputdata files needed in reporting to run folder
  • adjust reporting script to read in new reporting folder
  • remove no longer needed reporting functions reportDIETER (no longer used) and reportExtraEmissions (moved to remind2)

Reported variables depending on extra data can vary slightly, because the calculations now use the latest inputdata instead of the data previously stored in the remind2 library. Examples: Emi|CO2|Cumulated|Energy|Demand|Buildings, Cap|Electricity|Coal|Other Fossil Adjusted.

Type of change

Indicate the items relevant for your PR by replacing ◻️ with ☑️.
Do not delete any lines. This makes it easier to understand which areas are affected by your changes and which are not.

Parts concerned

  • ◻️ GAMS Code
  • ☑️ R-scripts
  • ◻️ Documentation (GAMS incode documentation, comments, tutorials)
  • ◻️ Input data / CES parameters
  • ◻️ Tests, CI/CD (continuous integration/deployment)
  • ◻️ Other (please give a description)

Impact

  • ◻️ Bug fix
  • ☑️ Refactoring
  • ◻️ New feature
  • ☑️ Change of parameter values or input data (including CES parameters)
  • ☑️ Minor change (default scenarios show only small differences)
  • ◻️ Fundamental change of results of default scenarios

Checklist

Do not delete any line. Leave unfinished elements unchecked so others know how far along you are.
In the end all checkboxes must be ticked before you can merge
.

  • I executed the automated model tests (make test) after my final commit and all tests pass (FAIL 0)
  • I adjusted the reporting in remind2 if and where it was needed
  • My code follows the coding etiquette
  • I explained my changes within the PR, particularly in hard-to-understand areas
  • I checked that the in-code documentation is up-to-date
  • I adjusted forbiddenColumnNames in readCheckScenarioConfig.R in case the PR leads to deprecated switches
  • I updated the CHANGELOG.md correctly (added, changed, fixed, removed, input data/calibration)

Further information (optional)

  • Runs with these changes are here:
  • Comparison of results (what changes by this PR?):

@fbenke-pik fbenke-pik changed the title remove no longer needed reporting functions refactor reporting functions Apr 10, 2025
@fbenke-pik
fbenke-pik marked this pull request as ready for review April 25, 2025 10:12
@fbenke-pik
fbenke-pik merged commit b4f96e0 into remindmodel:develop Apr 25, 2025
@fbenke-pik
fbenke-pik deleted the reporting branch April 25, 2025 12:38
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.

2 participants