Skip to content

L3 metadata updates#128

Draft
jtniehof wants to merge 12 commits into
IMAP-Science-Operations-Center:mainfrom
jtniehof:metadata_swe_spdf
Draft

L3 metadata updates#128
jtniehof wants to merge 12 commits into
IMAP-Science-Operations-Center:mainfrom
jtniehof:metadata_swe_spdf

Conversation

@jtniehof

Copy link
Copy Markdown
Collaborator

Draft PR with L3 metadata updates from instrument team and SPDF feedback.

Spreadsheet has been sent to the requesting parties with the line-by-line requests and resulting changes. Will make sample products once everyone has reviewed the changes; opening the PR early lets them see the specific diff.

@jtniehof jtniehof added Ins: SWE Related to the SWE instrument Data Release 1 Deadline: June 15, 2026 labels Jun 18, 2026
@jtniehof jtniehof added this to IMAP Jun 18, 2026
@jtniehof jtniehof force-pushed the metadata_swe_spdf branch from 9c939df to 61d79e5 Compare June 23, 2026 22:30
@jtniehof jtniehof force-pushed the metadata_swe_spdf branch from d7a2999 to 6461e1d Compare June 29, 2026 19:27
@jtniehof

Copy link
Copy Markdown
Collaborator Author

@pleasant-menlo, a heads-up: I switched the GLOWS L3b uv_anisotropy_flag metadata to record-varying, as it's not the same across the whole mission. I haven't checked if that might need code changes; will loop in later.

@hafarooki hafarooki left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a minor comment on the portion that changed for SWAPI

FIELDNAM: Quality Flags
CATDESC: Quality flags
FIELDNAM: Quality Flags for SWAPI L3a
CATDESC: "Quality flags for SWAPI L3a (0: no special concern; nonzero: use caution)"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently, except for PRELIMINARY_MAG, SWAPI reports only fill values when the other flags are set. So "use caution" and "indicates a specific potential concern" may not be the whole story. But maybe that's OK, and it might change in the future.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's very generic language I'm using for all the flags, trying to give the user some indication in CATDESC and UNITS of when they even need to pay attention. I'd be good with different wording, either generically or for SWAPI.

The list of flags is in VAR_NOTES; would it make sense to note there something along the lines of "If any flags other than PRELIMINARY_MAG are set, the output values are also set to fill"?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd be good with different wording, either generically or for SWAPI.

I think one generic wording is definitely good. I made some tentative suggestions.

The list of flags is in VAR_NOTES; would it make sense to note there something along the lines of "If any flags other than PRELIMINARY_MAG are set, the output values are also set to fill"?

I think that's unnecessary. The release notes and/or algorithm description already mention that. And the user can see it for themselves also. Plus, it may change eventually, and I'd think we would want one less thing to update if that happens... haha...

@jtniehof

Copy link
Copy Markdown
Collaborator Author

@pleasant-menlo, a heads-up: I switched the GLOWS L3b uv_anisotropy_flag metadata to record-varying, as it's not the same across the whole mission. I haven't checked if that might need code changes; will loop in later.

I ran the integration tests and this looks good. It was a 1D NRV and changed to a "scalar" RV, so the shape was always (1,) and it all carries through.

LABLAXIS: Flags
LABLAXIS: Quality flags for SWAPI L3a
VAR_NOTES: >-
Details in release notes. Each bit being set indicates a specific potential concern.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Details in release notes. Each bit being set indicates a specific potential concern.
Nonzero if there is a potential concern. Each bit corresponds to a specific potential concern. See release notes for details.

FIELDNAM: Quality Flags
CATDESC: Quality flags
FIELDNAM: Quality Flags for SWAPI L3a
CATDESC: "Quality flags for SWAPI L3a (0: no special concern; nonzero: use caution)"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd be good with different wording, either generically or for SWAPI.

I think one generic wording is definitely good. I made some tentative suggestions.

The list of flags is in VAR_NOTES; would it make sense to note there something along the lines of "If any flags other than PRELIMINARY_MAG are set, the output values are also set to fill"?

I think that's unnecessary. The release notes and/or algorithm description already mention that. And the user can see it for themselves also. Plus, it may change eventually, and I'd think we would want one less thing to update if that happens... haha...

FIELDNAM: Quality Flags
CATDESC: Quality flags
FIELDNAM: Quality Flags for SWAPI L3a
CATDESC: "Quality flags for SWAPI L3a (0: no special concern; nonzero: use caution)"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
CATDESC: "Quality flags for SWAPI L3a (0: no special concern; nonzero: use caution)"
CATDESC: "Quality flags for SWAPI L3a (caution required if nonzero)"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Data Release 1 Deadline: June 15, 2026 Ins: SWE Related to the SWE instrument

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants