search

openPMD / openPMD-viewer

:snake: Python visualization tools for openPMD files
https://openpmd-viewer.readthedocs.io/
Other
65 stars 50 forks source link

API & Slider: Coord->Component #150

Open ax3l opened 7 years ago

ax3l commented 7 years ago

Follow-up to #148: the "coord" option in the field API and interactive ipywidget should be renamed to component (or comp) since a component of a field does not necessarily reflect a certain quantity along a vector component of the chosen geometry. The current naming can be confusing, e.g. for tensor fields.

It is also the name used in the standard for the same reason, record and record component.

ax3l commented 7 years ago

For the time being, one can also add that option to the API with same functionality and print a deprecated warning if people still use the coord option. This would even be API compatible and one could remove it later on.

Renaming the slider label is possible at anytime.