You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rewrite README: lead with Python solver, not C++ binaries
- Intro now describes both backends (NumPy/CuPy + C++ binaries)
- Remove Colab reference and Binder badge (dead)
- Remove transducer walkthrough (too specific for README)
- Add uv run example and "no GPU required" note
- Simplify mission statement
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
9
-
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.
10
-
11
-
**New in v0.6.0:** Unified `kspaceFirstOrder()` API with a pure NumPy/CuPy solver. See the [API guide](https://k-wave-python.readthedocs.io/en/latest/get_started/new_api.html). The `kspaceFirstOrder()` API is experimental and may change before v1.0.0.
7
+
A Python implementation of [k-Wave](http://www.k-wave.org/) — 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).
12
8
13
9
## Mission
14
10
15
-
With this project, we hope to increase the accessibility and reproducibility of [k-Wave](http://www.k-wave.org/) simulations
16
-
for medical imaging, algorithmic prototyping, and testing. Many tools and methods of [k-Wave](http://www.k-wave.org/) can
17
-
be found here, but this project has and will continue to diverge from the original [k-Wave](http://www.k-wave.org/) APIs
18
-
to leverage pythonic practices.
11
+
Increase the accessibility and reproducibility of [k-Wave](http://www.k-wave.org/) simulations for medical imaging, algorithmic prototyping, and testing.
19
12
20
13
## Getting started
21
14
22
15

23
16
24
-
A large [collection of examples](../examples/) exists to get started with k-wave-python. All examples can be run in Google Colab notebooks with a few clicks. One can begin with e.g. the [B-mode reconstruction example notebook](https://colab.research.google.com/github/waltsims/k-wave-python/blob/HEAD/examples/legacy/us_bmode_linear_transducer/us_bmode_linear_transducer.ipynb).
17
+
A [collection of examples](../examples/) covers common simulation scenarios. Run any example locally:
18
+
19
+
```bash
20
+
uv run python examples/ivp_homogeneous_medium.py
21
+
```
25
22
26
-
This example file steps through the process of:
27
-
1. Generating a simulation medium
28
-
2. Configuring a transducer
29
-
3. Running the simulation
30
-
4. Reconstructing the simulation
23
+
No GPU required — all examples run on CPU with NumPy.
31
24
32
25
## Installation
33
26
34
-
To install using[uv](https://docs.astral.sh/uv/) (recommended):
0 commit comments