Skip to main content

k-wave-python

Support Documentation Status codecov

A Python implementation of k-Wave — an acoustics toolbox for time-domain simulation of acoustic wave fields. Includes a pure NumPy/CuPy solver (backend="python") and an interface to the pre-compiled k-Wave C++ binaries (backend="cpp") with NVIDIA GPU support (sm 5.0–9.0a).

Mission

Increase the accessibility and reproducibility of k-Wave simulations for medical imaging, algorithmic prototyping, and testing.

Getting started

A collection of examples covers common simulation scenarios. Run any example locally:

uv run examples/ivp_homogeneous_medium.py

No GPU required — all examples run on CPU with NumPy.

Installation

Using uv (recommended):

uv add k-wave-python

Or with pip:

pip install k-wave-python

Development

Development instructions can be found here.

Related Projects

  1. k-Wave: A MATLAB toolbox for the time-domain simulation of acoustic wave fields.
  2. j-wave: Differentiable acoustic simulations in JAX.
  3. ADSeismic.jl: a finite difference acoustic simulator with support for AD and JIT compilation in Julia.
  4. stride: a general optimisation framework for medical ultrasound tomography.

Documentation

The documentation for k-wave-python can be found here.

Citation

@software{k-Wave-Python,
author = {Yagubbayli, Farid and Sinden, David and Simson, Walter},
license = {GPL-3.0},
title = {{k-Wave-Python}},
url = {https://github.com/waltsims/k-wave-python}
}

Contact

e-mail walter.a.simson@gmail.com.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

k_wave_python-0.6.2.tar.gz (345.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

k_wave_python-0.6.2-py3-none-any.whl (224.6 kB view details)

Uploaded Python 3

File details

Details for the file k_wave_python-0.6.2.tar.gz.

File metadata

  • Download URL: k_wave_python-0.6.2.tar.gz
  • Upload date:
  • Size: 345.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.9

File hashes

Hashes for k_wave_python-0.6.2.tar.gz
Algorithm Hash digest
SHA256 c5ef30d0abeb02e83f9882d3e77c20c86d5bf3e3164e621cf50874a16099d62f
MD5 7ae50c63299be8e51e346dbd7158f5d7
BLAKE2b-256 13b6049e067cf5b9ce5ede9f8b274ed81570e7bd4ab7a72ec82e8b43cae0d472

See more details on using hashes here.

File details

Details for the file k_wave_python-0.6.2-py3-none-any.whl.

File metadata

File hashes

Hashes for k_wave_python-0.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 618e417cc939c0135fe45972db52bbd92342b880f54744957ac6d03eb1ab8d6d
MD5 4a69dbcab3e795560566de06275e352b
BLAKE2b-256 c3b8f3b1b27b65a98dacde3f653e40b429237823583ea75e4658ebd584f21469

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.6.2 This release

2 files

0.6.1

2 files

0.6.0

2 files

0.4.0

2 files

0.3.7

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

1 file

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page