Skip to content
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

Data model for GFA summary files #202

Merged
merged 35 commits into from
Jan 27, 2025
Merged

Data model for GFA summary files #202

merged 35 commits into from
Jan 27, 2025

Conversation

weaverba137
Copy link
Member

This PR closes #201.

We still need to fill in the details of the stub data model file, so please do not merge yet.

@weaverba137 weaverba137 added the WIP Work in Progress label Nov 18, 2024
@weaverba137 weaverba137 self-assigned this Nov 18, 2024
@coveralls
Copy link

coveralls commented Nov 18, 2024

Coverage Status

coverage: 100.0%. remained the same
when pulling 90df4f2 on gfa-summary
into 6684057 on main.

@weaverba137
Copy link
Member Author

Also note: ensure that EXTNAME is set for all HDUs: desihub/gfa_reduce#26.

@araichoor
Copy link
Contributor

for reference, this page hopefully has description of most of the columns: https://desi.lbl.gov/trac/wiki/SurveyValidation/SV1/conditions/summary_files.

@weaverba137
Copy link
Member Author

Thank you @araichoor, I'll try to fill in as much from there as possible.

@sbailey
Copy link
Contributor

sbailey commented Dec 3, 2024

Checking in on the status of this. It looks like the EXPOSURE_SUMMARY and EXPOSURE_SUMMARY_STRICT HDUs are well documented, but there are many missing descriptions for CAMERA_SUMMARY, which includes the caveat "... most of which shouldn't be relevant for the purpose of estimating effective exposure times." It looks like many of them could be filled in by extrapolating from other columns, e.g. MAX_Q1 does have a description, from which we could make a reasonable guess of what MIN_Q1, MEAN_Q1, and MEAN_QA also mean.

In the spirit of not letting the perfect be the enemy of the good, let's either wrap this up in the next week or so, or merge it as-is and save further documentation for if/when we really need it.

@weaverba137
Copy link
Member Author

@ameisner, in the CAMERA_SUMMARY HDU, do the columns come from header cards in another file? If so, do those header cards have comments? If so, we could just grab the descriptions from those comments. It's just a matter of which file contains these headers.

@weaverba137 weaverba137 removed the WIP Work in Progress label Jan 24, 2025
@weaverba137 weaverba137 requested a review from sbailey January 24, 2025 17:30
@weaverba137
Copy link
Member Author

@sbailey, please give a quick review if you have time. I think this is ready to merge.

Thank you @ameisner!

@sbailey sbailey merged commit 9b94c46 into main Jan 27, 2025
26 checks passed
@sbailey sbailey deleted the gfa-summary branch January 27, 2025 21:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create data model for GFA summary files
5 participants