[issue-262] Add metadata for plotting 2D equilibrium in the poloidal_…#263
[issue-262] Add metadata for plotting 2D equilibrium in the poloidal_…#263imbeauf wants to merge 1 commit into
Conversation
…plane_coordinates_identifier.xml
imbeauf
requested review from
DavidPCoster,
SimonPinches,
aksinghh,
medvedevsyu,
pankin,
qsthayashi,
simpla-fusion and
yegakjh
as code owners
| >1</int> | ||
| <int name="inverse" | ||
| description="Rhopolar_polar 2D polar coordinates (rho=dim1, theta=dim2) with magnetic axis as centre of grid; the polar angle is theta= -atan2(z-zaxis,r-raxis)." units="m,rad" | ||
| description="Rhopolar_polar 2D polar coordinates (rho=dim1, theta=dim2) with magnetic axis as centre of grid; the polar angle is theta= -atan2(z-zaxis,r-raxis)." units="m,rad" axis_labels="rho,polar_angle" |
There was a problem hiding this comment.
Better polar_angle or theta for representation on axis? Both are used in the description.
| axis_labels="psi,equal_arc_fourier" >15</int> | ||
| <int name="inverse_psi_polar_fourier" | ||
| description="Flux surface type with psi as radial label (dim1) and Fourier modes in the polar poloidal angle (mod(index,10)=6) (dim2); could be non-equidistant" units="Wb,1" | ||
| description="Flux surface type with psi as radial label (dim1) and Fourier modes in the polar poloidal angle (mod(index,10)=6) (dim2); could be non-equidistant" units="Wb,1" axis_labels="psi,equal_arc_fourier" |
There was a problem hiding this comment.
Is equal_arc_fourier the right term here, as the description says could be non-equidistant ?
Also I noted that we use in several coordinates identifier the same equal_arc_fourier but the associated description may be slightly different, or at least phrased differently. Could this be made more uniform?
|
There is no developer guide entry for axis_labels. The units_paths/units convention has a documented code-block example in docs/dd_developer_guide.rst. axis_labels has none. At minimum, a short paragraph + example should be added alongside the units_paths documentation, including the implicit rule that axis_labels[i] corresponds to the i-th path in units_paths. We could consider adding a axis_paths convention, but in practice it would mirror the the existing units_paths element. The one exception would be a case (not present here) where we would have a set with fixed units but different axis labels that we want to annotate. These XML elements do not appear to be 'wired' and are thus seen as documentation only. I was not aware that we had this units_paths mechanism for untangling 'mixed' units. Although this information would only be available at runtime only (a dynamic unit). To be avoided wherever possible. |
5 participants
…plane_coordinates_identifier.xml
📚 Documentation preview 📚: https://imas-data-dictionary--263.org.readthedocs.build/en/263/