examples

Examples

Many examples from k-wave-python are Python mirrors of the large collection of great examples from the original k-wave project. All examples are included as python files or notebooks in a subdirectory of the example directory. When running the examples in Google Colab, remember to select a GPU runtime for GPU simulations. Every example has a short readme.md file which briefly describes the purpose of the example.

List of Examples

• Array as a sensor (original example, )

• Array as a source (original example, )

• Linear array transducer (original example, )

• Photoacoustic Waveforms (original example, )

• Controlling the PML (original example, )

• Defining An Ultrasound Transducer Example (original example, )

• Simulating Ultrasound Beam Patterns(original example, )

• Linear transducer B-mode (original example, )

• Phased array B-mode (original example, )

• Circular piston transducer (original example, )

• Circular piston transducer (axisymmetric) (original example, )

• Focused bowl transducer (original example, )

• Focused bowl transducer (axisymmetric) (original example, )

• Focused annular array (original example, )

• Focussed Detector In 2D Example (original example, )

• Focussed Detector In 3D Example (original example, )

• Modelling Sensor Directivity In 2D Example (original example, )

Contributing new examples

When adding a new example notebook, follow these steps:

1. Search the list of examples to find an open example.
2. Claim your example by opening an "Example" issue on GitHub.
3. Fork and clone the repository and create a branch for your new example.
4. Create an example sub-directory using the name from the hyperlink of the original k-wave example if it exists (e.g. for http://www.k-wave.org/documentation/example_ivp_loading_external_image.php name the directory "ivp_loading_external_image).
5. Add your example notebook to your example directory.
6. Create a Python script that mirrors your example notebook in the same directory. Using nbconvert is an easy way to convert to a Python script using jupyter nbconvert --to python --RegexRemovePreprocessor.patterns="^%" <notebook_path>
7. Add a README.md file to your example directory briefly describing the concept or principle the example is meant to display and linking to the origonal k-wave example page if it exists.
8. Include a link in the README.md in the examples directory to a colab notebook for your example.
9. Add a your example to the list on this README.md and add a colab badge using html OR copy the pure markdown version above.
10. Open a pull request that closes the open issue from your forked example branch and name pull request "[Example] <name of your example>".

Thanks for contributing to k-wave-python!