[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 9 commits into
Conversation
…plane_coordinates_identifier.xml
| >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.
There was a problem hiding this comment.
And should Rhopolar be rho_pol ?
|
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. |
Yes, I have updated the developer guide accordingly. |
SimonPinches
left a comment
SimonPinches
left a comment
There was a problem hiding this comment.
Maybe I don't quiet understand what this metadata should contain but I think we could make it slightly more rigorous, especially for straight field-line coordinates (note the hyphenation!) where we don't seem to keep track of the type (PEST, Boozer, etc).
| >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.
And should Rhopolar be rho_pol ?
| >2</int> | ||
| <int name="inverse_psi_straight_field_line" | ||
| description="Flux surface type with psi as radial label (dim1) and the straight-field line poloidal angle (mod(index,10)=1) (dim2); could be non-equidistant; magnetic axis as centre of grid" units="Wb,rad" | ||
| description="Flux surface type with psi as radial label (dim1) and the straight-field line poloidal angle (mod(index,10)=1) (dim2); could be non-equidistant; magnetic axis as centre of grid" units="Wb,rad" axis_labels="psi,straight_field_line_angle" |
There was a problem hiding this comment.
There are an infinite number of different types of straight field-line coordinates and thus poloidal angle deformations. Is it to be assumed that here the toroidal coordinate is the usual toroidal angle, phi, and these are therefore PEST coordinates, or...?
There was a problem hiding this comment.
For the "inverse" case: for this one, the radial coordinate is ill-defined. According to @jfartaud, CHEASE (from which this identifier list is derived) is using psi as radial coordinate for the "inverse" case, which means "inverse" is the same as the "inverse_psi_polar" case. I propose then to rename "inverse" as "inverse_psi_polar" and indicate "inverse" as an alias for backward compatibility.
For the "straight field-line coordinates", I suggest that @SimonPinches indicates the most commonly used definition, I will report it in the identifier at the relevant places.
Co-authored-by: Simon Pinches <SimonPinches@users.noreply.github.com>
|
Closes #262 |
8 participants
…plane_coordinates_identifier.xml
📚 Documentation preview 📚: https://imas-data-dictionary--263.org.readthedocs.build/en/263/