Skip to content

Fullwave example #650

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

Open
djps wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Fullwave example #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
251d4a1
Add fullwave_simple_plane_wave simulation example
djps Nov 24, 2025
945bf9b
Add README for Simple Plane Wave example
djps Nov 24, 2025
ef8f7f8
Add ipynb
djps Nov 24, 2025
877a456
Update README to include k-wave-python link
djps Nov 24, 2025
ef81f9f
Add HTML display for animation in notebook
djps Nov 24, 2025
c0e2fad
Fix import statement formatting in Jupyter notebook
djps Nov 24, 2025
4064d07
Remove commented out code for clarity
djps Nov 24, 2025
645ed94
Fix type hint and formatting in Jupyter notebook
djps Nov 24, 2025
5aa36b0
Remove animation save and plot close commands
djps Nov 24, 2025
a418f13
Reorganize imports in fullwave_simple_plane_wave.py
djps Nov 24, 2025
7ac735c
Fix import order and update type hint for map_data
djps Nov 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions examples/fullwave_simple_plane_wave/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Simple Plane Wave

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/waltsims/k-wave-python/blob/HEAD/examples/fullwave_simple_plane_wave.ipynb)

This example showcases the compatibility between [fullwave25](https://github.com/pinton-lab/fullwave25) and [k-wave-python](https://github.com/waltsims/k-wave-python). It directly copies two methods over.
Comment on lines +1 to +5
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 24, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix Colab badge link to point to the correct notebook path

The Colab badge currently links to:

.../examples/fullwave_simple_plane_wave.ipynb

but the notebook in this PR lives at:

examples/fullwave_simple_plane_wave/fullwave_simple_plane_wave.ipynb

Recommend updating the URL accordingly:

-[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/waltsims/k-wave-python/blob/HEAD/examples/fullwave_simple_plane_wave.ipynb)
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/waltsims/k-wave-python/blob/HEAD/examples/fullwave_simple_plane_wave/fullwave_simple_plane_wave.ipynb)

So users can open the example notebook directly from the README.

🤖 Prompt for AI Agents 
In examples/fullwave_simple_plane_wave/README.md around lines 1 to 5, the Colab
badge URL points to examples/fullwave_simple_plane_wave.ipynb but the notebook
actually resides at
examples/fullwave_simple_plane_wave/fullwave_simple_plane_wave.ipynb; update the
badge link to the correct path (replace the URL portion after
/github/.../blob/HEAD/ with
examples/fullwave_simple_plane_wave/fullwave_simple_plane_wave.ipynb) so the
badge opens the notebook directly in Colab.


Loading
Loading