Skip to content

Improve descriptive_names#44

Merged
Zetison merged 10 commits intomainfrom
enhance/descriptive_names
Dec 17, 2025
Merged

Improve descriptive_names#44
Zetison merged 10 commits intomainfrom
enhance/descriptive_names

Conversation

@Zetison
Copy link
Collaborator

@Zetison Zetison commented Dec 17, 2025

This PR adds more descriptive names for more EMX packages and adds a comprehensive test to check if all nodes contains descriptions. The idea is to have a fallback description for all the main EMX packages which can be overwritten in three different ways as explained by the docs.

The example includes EnergyModelsGeography in combindation with EnergyModelsInvestments at the top level:

image

and a comprehensive collection of nodes compiled by the examples of EMX packages:

image

For completeness, the second area (Coal area) can be illustrated by the following

image

Jon Vegard Venås added 6 commits December 17, 2025 12:27
…"data"-menu by including the `id` field in parantheses. Also, improve the info-box.
… Introduced module names as intermediate `Dict`s in the `structures` field of `descriptive_names` (this is a breaking change).
…es (through a `.geojson` file location provided by the keyword argument `map_boundary_file` in the `GUI`-function).
@Zetison Zetison requested a review from dqpinel December 17, 2025 12:33
@Zetison Zetison self-assigned this Dec 17, 2025
@Zetison Zetison added the enhancement New feature or request label Dec 17, 2025
Copy link
Collaborator

@dqpinel dqpinel left a comment

Choose a reason for hiding this comment

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

Some minor changes to be made in the documentation otherwise ok.

@@ -0,0 +1,30 @@
# [Improve performance](@id how_to-improve_performance)

Due to the just-in-time (JIT) compilation of Julia, the instantiation of the `EnergyModelsGUI` window takes some time (but reopening the windo will take less time) and this also includes interactive features in the GUI (plotting a plot over `OperationalPeriod`s is a lot faster compared to the first plot).
Copy link
Collaborator

Choose a reason for hiding this comment

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

Some general comments:
Maybe split the sentence before the "and this also includes"
"plotting a plot" is redundant
I don't really understand what you mean with the sentence in paentheses: what is the first plot?
use "faster than" rather than "faster coompared to"

const TS = TimeStruct

"""
All-in-one-case: combines all nodes from the main EMX packages.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should you specify the version of all EMX packages used in the example to make it easier to keep track of what is missing or outdated for future maintenance? I can imagine this gets forgotten while doing other changes to the package and keeping track of what needs to be updated being difficult.

@Zetison Zetison requested a review from dqpinel December 17, 2025 13:15
@Zetison Zetison merged commit 090909c into main Dec 17, 2025
3 checks passed
@Zetison Zetison deleted the enhance/descriptive_names branch December 17, 2025 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants