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

Phasing memo 2.0 #1442

Merged
merged 4 commits into from
Jun 6, 2024
Merged

Phasing memo 2.0 #1442

merged 4 commits into from
Jun 6, 2024

Conversation

kartographer
Copy link
Contributor

Updates the phasing memo.

Description

Updates the phasing memo to document the "new" phasing framework within pyuvdata (primarily for UVData objects).

Motivation and Context

I was asked for documentation on phasing, and 3 years later I've finally finished it!

Types of changes

  • Documentation change (documentation changes only)

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

Copy link

codecov bot commented Jun 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.93%. Comparing base (02baee4) to head (beb3c34).

Additional details and impacted files
@@              Coverage Diff              @@
##           prep_v3.0    #1442      +/-   ##
=============================================
- Coverage      99.93%   99.93%   -0.01%     
=============================================
  Files             41       40       -1     
  Lines          21138    21103      -35     
=============================================
- Hits           21124    21089      -35     
  Misses            14       14              

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

@bhazelton bhazelton added the docs documentation label Jun 5, 2024
@bhazelton
Copy link
Member

Why is the calfits memo pdf updated in this PR?

@kartographer
Copy link
Contributor Author

kartographer commented Jun 5, 2024

@bhazelton -- I edited the calfits.tex file in #1437 but forgot to recompile. At issue I believe was the update for input_flag_array moving into v3.

Copy link
Member

@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.

This is great, thank you! Lots of little comments but generally I really like your updates, especially the primer on celestial coordinate systems -- super useful.

docs/references/phasing.tex Outdated Show resolved Hide resolved
docs/references/phasing.tex Outdated Show resolved Hide resolved
docs/references/phasing.tex Outdated Show resolved Hide resolved
docs/references/phasing.tex Outdated Show resolved Hide resolved
docs/references/phasing.tex Outdated Show resolved Hide resolved
docs/references/phasing.tex Outdated Show resolved Hide resolved
docs/references/phasing.tex Outdated Show resolved Hide resolved
docs/references/phasing.tex Outdated Show resolved Hide resolved
docs/references/phasing.tex Outdated Show resolved Hide resolved
docs/references/phasing.tex Outdated Show resolved Hide resolved
@kartographer
Copy link
Contributor Author

Thanks @bhazelton! All little comments should now be addressed (along with one final check for misspellings which I apparently forgot to do on the last run).

Copy link
Member

@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 more minor things but I think we're close!

docs/references/phasing.tex Outdated Show resolved Hide resolved
docs/references/phasing.tex Outdated Show resolved Hide resolved
docs/references/phasing.tex Outdated Show resolved Hide resolved
Copy link
Member

@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.

Looks good, thank you!!

@bhazelton bhazelton merged commit da82ef6 into prep_v3.0 Jun 6, 2024
46 checks passed
@bhazelton bhazelton deleted the phasing_memo branch June 6, 2024 21:16
@bhazelton bhazelton mentioned this pull request Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants