Skip to content

Feature/replace dim x with identifier#86

Merged
olivhoenen merged 7 commits into
iterorganization:developfrom
jwasikpsnc:feature/replace_dimX_with_identifier
Jun 25, 2026
Merged

Feature/replace dim x with identifier#86
olivhoenen merged 7 commits into
iterorganization:developfrom
jwasikpsnc:feature/replace_dimX_with_identifier

Conversation

@jwasikpsnc

@jwasikpsnc jwasikpsnc commented Jun 11, 2026

Copy link
Copy Markdown
Collaborator

@mfiaudrin-epsyl FYI: keys in the response are always there, if there is no alias, then alias=None

Example response:

"coordinates": [
      {
        "name": "dim1",
        "alias": "R",
        "target": "#equilibrium/time_slice[0]/profiles_2d[0]/psi",
        "unit": "mixed",
        "unit_alias": null,
        "shape": [
          65
        ],
        ...
    }

@read-the-docs-community

read-the-docs-community Bot commented Jun 11, 2026

Copy link
Copy Markdown

Documentation build overview

📚 imas-ibex | 🛠️ Build #33291811 | 📁 Comparing 91c405c against latest (b84903c)

  🔍 Preview build  

132 files changed · + 82 added · ± 50 modified

+ Added

± Modified

@jwasikpsnc jwasikpsnc marked this pull request as draft June 12, 2026 08:29
@jwasikpsnc

Copy link
Copy Markdown
Collaborator Author

Alias is now put into "name" response field.
No changes on FE side needed.
image

@jwasikpsnc jwasikpsnc marked this pull request as ready for review June 12, 2026 10:00
…re/replace_dimX_with_identifier

# Conflicts:
#	backend/ibex/data_source/imas_python_source.py
#	backend/tests/conftest.py
#	backend/tests/test_data_endpoints.py

@olivhoenen olivhoenen left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In you plot example from #86 (comment) the units for R and Z are wrong, they should be [m]

:param grid_node: IDSNode (named dimX, X = [1...N])
:return:
"""
result = {"alias": None, "unit_alias": None}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

You should better use keys named "axis_labels" and "units", speking of alias here is going to be confusing in the long term as in the DD identifiers alias metadata has another meaning

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Unit alias won't work until new version of DD and IMAS-Python is released.
Code extracting them is left for the future.

Will rename alias->axis_label and unit_alias->unit

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Unit alias won't work until new version of DD and IMAS-Python is released. Code extracting them is left for the future.

In DD units are there already (only axis_label is missing but you are not using it) since 4.1.0, in IMAS-Python, the identifiers API has been extended to allow access to units since 2.3.0 which was released last week.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done
Ready for further review

@olivhoenen

Copy link
Copy Markdown
Contributor

Got the correct units now, thanks!

@olivhoenen olivhoenen merged commit 3d22acd into iterorganization:develop Jun 25, 2026
12 checks passed
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