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

[WIP] Update uvdata tutorial #1534

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[WIP] Update uvdata tutorial #1534

wants to merge 6 commits into from

Conversation

jpober
Copy link
Member

@jpober jpober commented Mar 11, 2025

Description

Updates to the tutorial to make it more pedagogical and more consistent with modern pyuvdata

Motivation and Context

Our tutorial was not well-ordered from a pedagogical point of view (e.g. beginning with files conversions). Subsections have been reordered to (hopefully) make a more useful document for a new user to sit down and work through. References to older versions of pyuvdata have also largely been removed.

Closes #1341

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

Copy link

codecov bot commented Mar 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.93%. Comparing base (5ea0614) to head (eb3b412).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1534   +/-   ##
=======================================
  Coverage   99.93%   99.93%           
=======================================
  Files          63       63           
  Lines       21758    21758           
=======================================
  Hits        21743    21743           
  Misses         15       15           

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

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

I'll work on the todos. I found a couple other minor things in my read through.

the physical orientation of the dipole can also be used (e.g. "nn" or "ee).
UVData: Phasing
---------------
Phasing/unphasing data
Copy link
Member

Choose a reason for hiding this comment

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

I think we need a short paragraph describing the idea of phasing, mentioning the types of phase centers and pointing to the phasing memo for more information.

jpober and others added 4 commits March 11, 2025 14:11
Change the order and clean up initial text in the UVData tutorial
Rearrange the existing code snippits into a more sensible order
get rid of the "file conversion" section
@bhazelton bhazelton force-pushed the update_uvdata_tutorial branch from 15a863b to ec08d90 Compare March 11, 2025 21:11
@bhazelton bhazelton added docs documentation UVData labels Mar 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation UVData
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reorganize tutorial
2 participants