Related Issues

• Implements Add units choice to the show function #716

Notes

This adds a new units_length parameter to the show function and allows the user to choose the length units for displaying Magpylib objects per-row-and-column.

Side effects

• The zoom parameter is now also per-row-and-column.
• Ranges are individual for each plot and not overall like before.
• Pyvista plots have grids visible by default to show axes labels
• colors are iterating over subplots (before, a new cycle started for each subplot)

Examples

import magpylib as magpy

c1 = magpy.magnet.Cuboid(
    dimension=(1, 1, 1),
    polarization=(1, 2, 3),
)

with magpy.show_context(c1, backend="matplotlib") as s:
    s.show(row=1, col=1, units_length="m", zoom=3)
    s.show(row=1, col=2, units_length="dm", zoom=2)
    s.show(row=2, col=1, units_length="cm", zoom=1)
    s.show(row=2, col=2, units_length="mm", zoom=0)

Tasks

• Allow length units:
  • classic ones ['ym', 'zm', 'am', 'fm', 'pm', 'nm', 'µm', 'mm', 'm', 'km', 'Mm', 'Gm', 'Tm', 'Pm', 'Em', 'Zm', 'Ym']
  • "dm" and cm (only for manuel entry, "auto" will not infer these
  • None defaults to SI (m) and does not show unit in axes labels
  • "auto" will infer a suitable length unit depending on the max range value for each subplot independently
  • define default value ("m", "auto" or None)
• Adapt ranges to units per row-col-combination.
• Catch inconsistent identifiers (zoom, units_length, etc. ) as per row-col basis.
• Ensure all elements are correctly scaled
  • paths
  • arrows
  • meshes
  • extra generic traces
  • extra non generic traces
• Pass on right unit in axes labels
  • matplotlib
  • plotly
  • pyvista
• Docs: add or modify an example to reflect the changes
• Testing: add unit tests to cover the common and edge cases
• Changelog: document new feature