Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replaced config.log and config.Rdata with config.yml #368

Merged
merged 5 commits into from
Jan 25, 2022

Conversation

tscheypidi
Copy link
Member

@tscheypidi tscheypidi commented Jan 21, 2022

🐦 Purpose of this PR 🐦

This PR improves the handling of settings in the model output folder. Instead of 2 files (a machine readable config.Rdata and a human readable config.log) we have now one unified file which serves both purposes.

  • replaced redundant files config.Rdata and config.log with config.yml
  • removed confidential information from config before storing it in config.yml

🔧 Checklist for PR creator 🔧

  • Low risk : Simple bugfixes (missing files, updated documentation, typos) or Start/output scripts
  • Medium risk : New realization / Changes to existing realization / Other changes which don't modify default.cfg
  • High risk : New input files (if cfg$input is changed in default.cfg) / Modification to core model (eg. changes in equations, calculations, introduction of new sets etc.) / Other changes in default.cfg
  • Providing additional information based on PR label
  • Low risk : No new model run needed.
  • Medium risk : Default run based on the current version of the fork from which PR is made
  • High risk
    • Default run from the current develop branch
    • Default run based on the current version of the fork from which PR is made
  • 📉 Performance loss/gain from current default behavior 📈

    • Current develop branch default : ** mins
    • This PR's default : ** mins
  • Added changes to CHANGELOG.md

  • Compilation check (model starts without compilation errors - use gams main.gms action=c in model folder for testing).

  • No hard coded numbers and cluster/country/region names.

  • The new code doesn't contain declared but unused parameters or variables.

  • Where relevant, In-code comments added including documentation comments.

  • Made sure that documentation created with goxygen is okay (use goxygen::goxygen() for testing).

  • Changes to magpie4 R library for post processing of model output (ideally backward compatible).

  • Self-review of my own code.

  • For high risk runs: validation of major model indicators - Land-use, emissions, food prices, Tau. %Delete this line in case it is not a high risk run%

⚠️ Additional notes or warnings ⚠️

NA

🚨 Checklist for RSE reviewer 🚨

  • PR is labeled correctly.
  • CHANGELOG is updated correctly
  • No hard coded numbers and cluster/country/region names.
  • No unnecessary increase in module interfaces
  • All required updates in interfaces (if any) have been properly adressed in the module contracts
  • In-code comments and documentation comments are satisfactory.
  • model behavior/performance is satisfactory.
  • Requested changes (if any) were applied correctly

🚨 Checklist for MAgPIE reviewer 🚨

  • PR is labeled correctly.
  • CHANGELOG is updated correctly
  • No hard coded numbers and cluster/country/region names.
  • Changes to the model are scientifically sound
  • In-code comments and documentation comments are satisfactory.
  • model behavior/performance is satisfactory.
  • Requested changes (if any) were applied correctly

* removed confidential information from config before storing it in config.yml
@tscheypidi tscheypidi added enhancement New feature or request Low risk Low risk labels Jan 21, 2022
@@ -7,7 +7,7 @@

scalars

s42_watdem_nonagr_scenario Scenario for non agricultural water demand from WATERGAP (1) / 1 /
s42_watdem_nonagr_scenario Scenario for non agricultural water demand from WATERGAP (1) / 2 /
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it have any effect for users that this parameter changed from 1 to 2?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch. No, it does not have an effect. It seems that there was just an inconsistency between the setting GAMS and in default.cfg. Now both show the same value (2).

@tscheypidi tscheypidi closed this Jan 24, 2022
@@ -12,6 +12,7 @@

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just caught my eye but not related to this PR: The name of this file is missing a "t" in "exising".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed as well

scripts/performance_test.R Outdated Show resolved Hide resolved
scripts/performance_test.R Show resolved Hide resolved
@tscheypidi tscheypidi merged commit 66ea42a into magpiemodel:develop Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Low risk Low risk
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants