Skip to content

Dispersion wave side issue #502

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.

Sign up for GitHub

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

Jump to bottom
Merged
ahmadtourei merged 5 commits into from
Jun 24, 2025
Merged

Dispersion wave side issue #502

ahmadtourei merged 5 commits into from
Jun 24, 2025

Conversation

@ahmadtourei
Copy link
Collaborator

@ahmadtourei ahmadtourei commented Jun 19, 2025 •
edited by coderabbitai bot
Loading

Description

This PR addresses issue #497 by providing notes for the patch.dispersion_phase_shift() method.

Checklist

I have (if applicable):

  • referenced the GitHub issue this PR closes.
  • documented the new feature with docstrings or appropriate doc page.
  • included a test. See testing guidelines.
  • your name has been added to the contributors page (docs/contributors.md).
  • added the "ready_for_review" tag once the PR is ready to be reviewed.

Summary by CodeRabbit

  • Documentation

    • Expanded and clarified instructions and examples in the dispersion phase shift function docstring, including guidance for handling left-sided and right-sided wavefields.

  • Tests

    • Improved numerical precision in aggregation tests by using a more robust assertion method for comparing results.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 19, 2025 •
edited
Loading

Walkthrough

The docstring for the dispersion_phase_shift function was expanded to clarify input requirements and provide additional usage examples, including handling left-sided wavefields. Separately, a test assertion in test_no_dim was updated to use a more robust numerical comparison method for verifying aggregation results.

Changes

File(s) Change Summary
dascore/transform/dispersion.py Expanded the dispersion_phase_shift docstring with clarifications, orientation instructions, and examples.
tests/test_proc/test_aggregate.py Updated test assertion in test_no_dim to use numpy.testing.assert_allclose for numerical comparison; imported numpy.testing.

Poem

A patch must face the rising tide,
From low to high, let channels glide.
If left is right, a flip will do,
The docstring guides you safely through.
And in the tests, precision's king—
Allclose brings a stable spring!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a9880e5 and 9bae644.

📒 Files selected for processing (2)
  • dascore/transform/dispersion.py (3 hunks)
  • tests/test_proc/test_aggregate.py (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: test_code_min_deps (windows-latest, 3.12)
  • GitHub Check: test_code_min_deps (macos-latest, 3.13)
  • GitHub Check: test_code_min_deps (windows-latest, 3.13)
  • GitHub Check: test_code_min_deps (macos-latest, 3.12)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.12)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.13)
  • GitHub Check: test_code (windows-latest, 3.12)
  • GitHub Check: test_code (windows-latest, 3.11)
  • GitHub Check: test_code (windows-latest, 3.10)
🔇 Additional comments (2)
dascore/transform/dispersion.py (1)

29-29: Excellent documentation enhancement for wavefield orientation requirements.

The clarification about right-sided wavefields is crucial for correct usage of this function. This addresses a common source of confusion and potential errors in dispersion analysis.

Also applies to: 53-57

tests/test_proc/test_aggregate.py (1)

6-6: Improved numerical stability in test assertion.

Excellent improvement! Using numpy.testing.assert_allclose with appropriate tolerances is the correct approach for comparing floating-point results, preventing potential test failures due to minor numerical precision differences.

Also applies to: 36-37

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@codecov
Copy link

codecov bot commented Jun 19, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.85%. Comparing base (a9880e5) to head (9bae644).
Report is 1 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master     #502   +/-   ##
=======================================
  Coverage   99.85%   99.85%           
=======================================
  Files         118      118           
  Lines        9711     9711           
=======================================
  Hits         9697     9697           
  Misses         14       14
Flag Coverage Δ
unittests 99.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

d-chambers
d-chambers approved these changes Jun 24, 2025
View reviewed changes
Copy link
Contributor

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

@ahmadtourei ahmadtourei merged commit 79c5fd8 into master Jun 24, 2025
19 checks passed
@ahmadtourei ahmadtourei deleted the dispersion_wave_side_issue branch June 24, 2025 01:19
This was referenced Jun 24, 2025
Closed
Closed
@coderabbitai coderabbitai bot mentioned this pull request Sep 18, 2025
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@d-chambers d-chambers d-chambers approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ahmadtourei @d-chambers