Skip to content

Enhance/descriptive names#43

Merged
Zetison merged 6 commits intomainfrom
enhance/descriptive_names
Dec 16, 2025
Merged

Enhance/descriptive names#43
Zetison merged 6 commits intomainfrom
enhance/descriptive_names

Conversation

@Zetison
Copy link
Collaborator

@Zetison Zetison commented Dec 16, 2025

This PR improves the handilng of descriptive_names (including a breaking change). It also provides more export options and enables custom boundary background map specifications. In particular:

  • Added missing descriptive names for the variables emissions_link, link_opex_var, link_opex_fixed and emissions_trans.
  • Enabled exporting topo axis to bmp, tif, tiff, jpg, jpeg, and png file format.
  • Enable custom boundary background map instead of the default coastlines (through a .geojson file location provided by the keyword argument map_boundary_file in the GUI-function).
  • Adjusted descriptive_names to be more robust to available packages. Introduced module names as intermediate Dicts in the structures field of descriptive_names (this is a breaking change).

Jon Vegard Venås added 6 commits December 16, 2025 11:02
…"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 Copilot December 16, 2025 11:24
@Zetison Zetison self-assigned this Dec 16, 2025
@Zetison Zetison added bug Something isn't working enhancement New feature or request labels Dec 16, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR enhances the handling of descriptive_names with a breaking change that introduces module names as intermediate dictionaries in the structures field. Key improvements include adding missing descriptive names for several variables, expanding export format support for the topology axis, and enabling custom boundary background maps.

  • Added missing descriptive names for emissions_link, link_opex_var, link_opex_fixed, and emissions_trans
  • Enabled exporting topology axis to additional image formats (bmp, tif, tiff, jpg, jpeg, png)
  • Restructured descriptive_names[:structures] to use module names as intermediate dictionaries for better package robustness

Reviewed changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
test/test_interactivity.jl Updated test expectations to include new export formats for Topo axis
test/test_descriptive_names.jl Updated tests to accommodate new module-based structure hierarchy and added comprehensive coverage tests
src/utils_gen/utils.jl Enhanced error handling in get_nested_value and refactored inherit_descriptive_names_from_supertypes! to support module-based structure
src/utils_gen/structures_utils.jl Removed unused loaded() function
src/utils_gen/export_utils.jl Added support for exporting Topo axis to multiple image formats
src/utils_GUI/results_axis_utils.jl Updated key string generation to include parent module in path
src/utils_GUI/GUI_utils.jl Refactored descriptive names handling, replacing update_descriptive_names! with create_descriptive_names and added get_descriptive_names functions
src/setup_topology.jl Updated docstring to reflect kwargs support
src/setup_GUI.jl Added map_boundary_file parameter and refactored boundary map rendering to support custom GeoJSON files
src/descriptive_names.yml Reorganized structure to group descriptive names by module and added missing variable descriptions
src/EnergyModelsGUI.jl Exported new public functions create_descriptive_names and get_descriptive_names
examples/generate_examples.jl Removed obsolete comments from example data
docs/src/library/public.md Added documentation entries for new exported functions
NEWS.md Added release notes for version 0.6.0
Comments suppressed due to low confidence (1)

test/test_descriptive_names.jl:1

  • This logic for extending selection when data is a Resource appears misplaced in the test file diff. This code should be in the source files, not in test changes. Verify this logic is in the correct location.
const EMB = EnergyModelsBase

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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

Labels

bug Something isn't working enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants