search

quintel / etengine

Calculation engine for the Energy Transition Model
https://energytransitionmodel.com/
MIT License
15 stars 7 forks source link

Better insight in scenario compatibility #1361

Closed noracato closed 5 months ago

noracato commented 1 year ago

You can view the current scenario in the engine to check the compatibility settings quickly, see the screenshot here below.

Screenshot 2023-09-28 at 14 13 03

However there are two issues with the current display:

  1. It is unclear what this compatibility actually means
  2. The link to the docs is broken

This issue proposes solutions for both these problems.

1. Changing the tags

The current way of displaying compatibility: Current model version only keep_compatible is set to false, but the scenario is young enough to be ok Outdated - not guaranteed keep_compatible is set to false, and the scenario is (most probably) too old to join migrations Keep compatible keep_compatible is set to true, the scenario is being migrated

We would like to split this up into two labels:

2. Update the link

The new link to the docs is https://docs.energytransitionmodel.com/api/scenarios#forward-compatibility

mabijkerk commented 1 year ago

but the scenario is young enough to be ok

Wat do you mean by this? Is this related to the '1 month old migration criterium'?

mabijkerk commented 1 year ago

Keep compatible => Simple True or False

Good idea!

Compatibility => Interpreting the current state: Fully compatible Within this deploy Possibly outdated

This seems fine, as long as there is good documentation what each state means. On their own I don't have a feeling for what these states mean.

github-actions[bot] commented 10 months ago

This issue has had no activity for 60 days and will be closed in 7 days. Removing the "Stale" label or posting a comment will prevent it from being closed automatically. You can also add the "Pinned" label to ensure it isn't marked as stale in the future.

github-actions[bot] commented 6 months ago

This issue has had no activity for 60 days and will be closed in 7 days. Removing the "Stale" label or posting a comment will prevent it from being closed automatically. You can also add the "Pinned" label to ensure it isn't marked as stale in the future.