Release 2.4.0

[SBlokhuizen]

Release notes IMAS-ParaView 2.4.0

This release introduces four new ParaView readers and includes several improvements and bug fixes.

Changes since version 2.3.1

4 new ParaView reader plugins

• (Shattered) Pellets Reader - for visualizing shattered pellet injector fragment positions and velocities from the spi IDS
• Camera Reader - for visualizing camera sightlines from the camera_ir and camera_visible IDSs, including the option to match the ParaView camera to a selected camera for a point-of-view visualization
• Distributions Reader - for visualizing particle distribution marker data from the distributions IDS
• Magnetics Reader - for visualizing flux loops, B-field probes, and Rogowski coils from the magnetics IDS

GGD reader improvements

• Added support for loading structured 2D GGD grids in the GGD reader
• Added option for cylindrical to Cartesian coordinate transformation of GGD vector components

Documentation improvements

• Overhauled Gallery section to make it easier for users to add new examples.
• Added several examples showing example workflows to the Gallery section.
• Redesigned Landing page with examples and links to the most important pages
• Plugin documentation page now features image previews with examples, making it much easier to navigate the different plugins.
• Added version tags to plugin documentation indicating when each plugin was introduced or changed.

Bug fixes

• Fixed psi grid and array loading in the 1D profiles mapper (Fix loading psi array in 1D mapper #57, Dynamically find psi grid in 1d profiles mapper #74)
• Fixed an issue where readers would fail to load an IDS with occurrence > 0 if occurrence 0 was missing (Fix uri loading issue if occurrence 0 is missing #79)
• Fixed the position reader to skip devices with unfilled positions, and allow visualization where phi is empty (Fix missing position issue #81)

[olivhoenen]

Looks great 👍
Just a few minor comments.
And also a general question: do we use at all the Python package uploaded to PyPI (besides the CLI), or we always need the sources when used as a pv plugin?

[SBlokhuizen]

Hi @olivhoenen, Thanks for your comments. I have implemented your feedback in #86.

@SBlokhuizen maybe you can add this record on the https://zenodo.org/communities/open-imas community?

I was unable to add an existing record to a community, so I have created a new record and requested it to be added to the Open IMAS community. Could you have a look at that? It should be available here, once accepted.

And also a general question: do we use at all the Python package uploaded to PyPI (besides the CLI), or we always need the sources when used as a pv plugin?

Yes, the PyPI package is used for both. If you don't have access to the IMAS-ParaView module, you can pip install imas-paraview and point PV_PLUGIN_PATH to the installed imas_paraview/plugins/ directory if you want to load the ParaView plugins. Some more information is in the installation instructions, hopefully that makes it clear.

[olivhoenen]

I was unable to add an existing record to a community, so I have created a new record and requested it to be added to the Open IMAS community. Could you have a look at that? It should be available here, once accepted.

This is surprising, it shall be possible to do it from existing records (cf. https://help.zenodo.org/docs/share/submit-to-community/), as this was done with the two previous records listed there. Anyway, your new record is now in the comunity, thx.

[SBlokhuizen]

@SimonPinches Thanks for your comments, I have addressed them in #88 and updated this release branch. If all is well for you and @paulotex, I am fine to merge this into main and create a new release tag.