CalH5 Memo

[bhazelton]

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:

• I have read the contribution guide.
• My code follows the code style of this project.

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!)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.92%. Comparing base (e2b73b4) to head (74acf53).
Report is 173 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.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[bhazelton]

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

[kartographer]

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.

[kartographer]

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")

[bhazelton]

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

[bhazelton]

found a couple typos

[kartographer]

Looking good to me, thanks @bhazelton!

[bhazelton]

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

[kartographer]

I dub thee memos plenipotentiary and extraordinary!