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

CalH5 Memo #1462

Merged
merged 4 commits into from
Aug 27, 2024
Merged

CalH5 Memo #1462

merged 4 commits into from
Aug 27, 2024

Conversation

bhazelton
Copy link
Member

@bhazelton bhazelton commented Jul 23, 2024

Description

Add a memo describing the CalH5 file format, along the lines of the UVH5 memo.

Also added several missing optional header items to the UVH5 memo and did some other doc updates.

Motivation and Context

closes #1424

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation change (documentation changes only)
  • Version change
  • Build or continuous integration change

Checklist:

Documentation change checklist:

  • Any updated docstrings use the numpy docstring format.
  • If this is a significant change to the readme or other docs, I have checked that they are rendered properly on ReadTheDocs. (you may need help to get this branch to build on RTD, just ask!)

@bhazelton bhazelton added the docs documentation label Jul 23, 2024
Copy link

codecov bot commented Jul 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.92%. Comparing base (e2b73b4) to head (74acf53).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1462   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files          61       61           
  Lines       21319    21319           
=======================================
  Hits        21304    21304           
  Misses         15       15           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bhazelton bhazelton marked this pull request as ready for review July 25, 2024 17:44
@bhazelton
Copy link
Member Author

I haven't yet added the pdfs to this PR since I figured there'd be updates needed, but I'm attaching them here to help with review.
calh5.pdf
uvh5_memo.pdf

@bhazelton bhazelton requested a review from plaplant July 25, 2024 17:54
Copy link
Contributor

@kartographer kartographer left a comment

Choose a reason for hiding this comment

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

I think this is looking good @bhazelton! One comment of moderate significance that I think should be fast to address, otherwise I think this is looking good to go.

various groups. We note in parenthesis the corresponding attribute of a UVCal
object. Note that in nearly all cases, the names are coincident, to make things
as transparent as possible to the user.

Copy link
Contributor

Choose a reason for hiding this comment

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

I may suggest providing here a brief synopsis of the different types of calibration solutions (delay vs gains; wideband versus freq-dependent/bandpass), just to help give some context up front (and also define terms like "wideband")

Copy link
Member Author

Choose a reason for hiding this comment

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

I added a paragraph in the introduction about this, let me know if it's sufficiently detailed.

Copy link
Member Author

@bhazelton bhazelton left a comment

Choose a reason for hiding this comment

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

found a couple typos

docs/references/calh5.tex Outdated Show resolved Hide resolved
docs/references/calh5.tex Outdated Show resolved Hide resolved
kartographer
kartographer previously approved these changes Aug 26, 2024
Copy link
Contributor

@kartographer kartographer left a comment

Choose a reason for hiding this comment

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

Looking good to me, thanks @bhazelton!

@bhazelton
Copy link
Member Author

ok, I'll add the pdfs and then get you to re-review @kartographer

Copy link
Contributor

@kartographer kartographer left a comment

Choose a reason for hiding this comment

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

I dub thee memos plenipotentiary and extraordinary!

@kartographer kartographer merged commit 690c7ce into main Aug 27, 2024
46 checks passed
@kartographer kartographer deleted the calh5_memo branch August 27, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Calibration docs documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CalH5 memo
2 participants