-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
JP-3901, JWSTKD-585: Keywords to support DHS development #426
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #426 +/- ##
=======================================
Coverage 78.35% 78.35%
=======================================
Files 109 109
Lines 5129 5129
=======================================
Hits 4019 4019
Misses 1110 1110 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
8b292f7
to
d4efab7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly number->integer suggestions and questions.
The titles don't seem very readable but I see those are the ones proposed in https://jira.stsci.edu/browse/JWSTKD-585
The suggestions removed abbreviations which I think improves their readability but I'm not going to press the point if it's easier to just go with the originally proposed wording.
title: Num. substripe rows read starting at SUBSTRT1 | ||
type: number |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title: Num. substripe rows read starting at SUBSTRT1 | |
type: number | |
title: Number of substripe rows read starting at SUBSTRT1 | |
type: number |
Will this ever be a non-integer value? If not, any reason to not make it an integer?
multistripe_skips1: | ||
title: Num. rows to skip after reading MSTR_RD1 rows | ||
type: number |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
multistripe_skips1: | |
title: Num. rows to skip after reading MSTR_RD1 rows | |
type: number | |
multistripe_skips1: | |
title: Number of rows to skip after reading MSTR_RD1 rows | |
type: number |
Same as above, should this be an integer?
title: Num. rows read in subsequent substripes | ||
type: number |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title: Num. rows read in subsequent substripes | |
type: number | |
title: Number of rows read in subsequent substripes | |
type: number |
Same as above, integer?
title: Num. rows to skip between susequent substripes | ||
type: number |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title: Num. rows to skip between susequent substripes | |
type: number | |
title: Number of rows to skip between subsequent substripes | |
type: number |
Fixed spelling and should this be an integer?
title: Repeat reading MSTR_RD2 rows at first position | ||
type: number |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title: Repeat reading MSTR_RD2 rows at first position | |
type: number | |
title: Repeat reading MSTR_RD2 rows at first position | |
type: integer |
I think this can only be 0 or 1 (based on the doc linked in https://jira.stsci.edu/browse/JWSTKD-585).
blend_table: True | ||
interleave_reads1: | ||
title: Interleave MSTR_RD1 rows between substripes | ||
type: number |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
type: number | |
type: integer |
Same as repeat_stripe.
blend_table: True | ||
superstripe_step: | ||
title: Rows to advance superstripe postn btwn intgrtns | ||
type: number |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
type: number | |
type: integer |
fits_keyword: MSTR_ILV | ||
blend_table: True | ||
superstripe_step: | ||
title: Rows to advance superstripe postn btwn intgrtns |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title: Rows to advance superstripe postn btwn intgrtns | |
title: Rows to advance superstripe position between integrations. |
title: Num. superstripe positions in super-integration | ||
type: number |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title: Num. superstripe positions in super-integration | |
type: number | |
title: Number of superstripe positions in super-integration | |
type: integer |
I think the primary issue with lengthening the titles is that they will be truncated in the FITS representation. For some reason I thought number was preferred over integer, but I'll get those changed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
If needed a follow up PR can update the titles.
Addresses JP-3901
Matches work in JWSTKD-585
This PR adds required keywords to support DHS development and processing.
Tasks
docs/
pageno-changelog-entry-needed
)changes/
:echo "changed something" > changes/<PR#>.<changetype>.rst
(see below for change types)jwst
regression tests with this branch installed ("git+https://github.com/<fork>/stdatamodels@<branch>"
)news fragment change types...
changes/<PR#>.feature.rst
: new featurechanges/<PR#>.bugfix.rst
: fixes an issuechanges/<PR#>.doc.rst
: documentation changechanges/<PR#>.removal.rst
: deprecation or removal of public APIchanges/<PR#>.misc.rst
: infrastructure or miscellaneous change