Skip to content

Commit 18dfd01

Browse files
waltsimsclaude
andcommitted
Trim v0.6.0 announcement in README to one line
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 580a31b commit 18dfd01

1 file changed

Lines changed: 1 addition & 18 deletions

File tree

docs/README.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,7 @@
88
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
99
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.
1010

11-
## What's New in v0.6.0
12-
13-
**Unified API:** A single `kspaceFirstOrder()` function replaces `kspaceFirstOrder2D` / `3D` and their options classes.
14-
Dimensionality is auto-detected from the grid. All simulation parameters are keyword arguments.
15-
16-
**Python solver:** A pure NumPy/CuPy solver runs 1D, 2D, and 3D simulations without the C++ binary.
17-
Use `device="gpu"` for GPU acceleration via CuPy.
18-
19-
```python
20-
from kwave.kspaceFirstOrder import kspaceFirstOrder
21-
22-
result = kspaceFirstOrder(kgrid, medium, source, sensor) # NumPy CPU
23-
result = kspaceFirstOrder(kgrid, medium, source, sensor, device="gpu") # CuPy GPU
24-
result = kspaceFirstOrder(kgrid, medium, source, sensor, backend="cpp") # C++ binary
25-
```
26-
27-
The legacy `kspaceFirstOrder2D` / `3D` functions still work but emit deprecation warnings.
28-
See the [Unified API guide](https://k-wave-python.readthedocs.io/en/latest/get_started/new_api.html) for migration details.
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).
2912

3013
## Mission
3114

0 commit comments

Comments
 (0)