Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# k-Wave-python
[![Documentation Status](https://readthedocs.org/projects/k-wave-python/badge/?version=latest)](https://k-wave-python.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/waltsims/k-wave-python/graph/badge.svg?token=6ofwtPiDNG)](https://codecov.io/gh/waltsims/k-wave-python)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/waltsims/k-wave-python/master)

This project is a Python implementation of v1.4.0 of the [MATLAB toolbox k-Wave](http://www.k-wave.org/) as well as an
interface to the pre-compiled v1.3 of k-Wave simulation binaries, which support NVIDIA sm 5.0 (Maxwell) to sm 9.0a (Hopper) GPUs.
Expand Down
2 changes: 2 additions & 0 deletions examples/at_array_as_sensor/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Defining A Sensor Using An Array Transducer Example

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

This example provides a demonstration of using the kWaveArray class to define an array transducer with 20 arc-shaped elements which is then used as a receiver array. It builds on the Defining A Source Using An Array Transducer Example.

To read more, visit the [original example page](http://www.k-wave.org/documentation/example_at_array_as_sensor.php)
2 changes: 2 additions & 0 deletions examples/at_array_as_source/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Defining A Source Using An Array Transducer Example

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

This example provides a demonstration of using the kWaveArray class to define an array transducer with three arc-shaped elements without staircasing errors.

For a more detailed discussion of this example and the underlying techniques, see E. S. Wise, B. T. Cox, J. Jaros, & B. E. Treeby (2019). Representing arbitrary acoustic source and sensor distributions in Fourier collocation methods. The Journal of the Acoustical Society of America, 146(1), 278-288. https://doi.org/10.1121/1.5116132.
Expand Down
2 changes: 2 additions & 0 deletions examples/at_linear_array_transducer/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Modelling A Linear Array Transducer Example

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

This example provides a demonstration of using the kWaveArray class to define a linear array transducer with 15 rectangular elements. Electronic focusing is then used to transmit an ultrasound pulse. It builds on the [Defining A Source Using An Array Transducer Example](../at_array_as_source/).

To read more, visit the [original example page](http://www.k-wave.org/documentation/example_at_linear_array_transducer.php).
2 changes: 2 additions & 0 deletions examples/ivp_photoacoustic_waveforms/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Initial Value Problem: Photoacoustic Waveforms in 2D and 3D

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

See the k-wave example [here](http://www.k-wave.org/documentation/example_ivp_photoacoustic_waveforms.php), which includes one-dimensional propagation as well.

> [!WARNING]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@
"metadata": {},
"outputs": [],
"source": [
"!pip install git+https://github.com/waltsims/k-wave-python"
"%%capture\n",
"!pip install k-wave-python"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
"metadata": {},
"outputs": [],
"source": [
"# Install k-wave-python if not installed yet (e.g. running in Google Colab)\n",
"#!pip install git+https://github.com/waltsims/k-wave-python"
"%%capture\n",
"!pip install k-wave-python"
Copy link
Collaborator

Choose a reason for hiding this comment

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

What if we install only if in colab? We can detect running in colab using the snippet here: https://stackoverflow.com/a/53586419

]
},
{
Expand Down
2 changes: 2 additions & 0 deletions examples/us_bmode_linear_transducer/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Simulating B-mode Ultrasound Images Example

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

This example illustrates how k-wave-python can be used for the simulation of B-mode ultrasound images (including tissue harmonic imaging) analogous to those produced by a modern diagnostic ultrasound scanner.


Expand Down