Skip to content

Commit 4a618c0

Browse files
waltsimsclaude
andcommitted
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>
1 parent 48add0d commit 4a618c0

1 file changed

Lines changed: 10 additions & 19 deletions

File tree

docs/README.md

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,31 @@
33
[![Support](https://img.shields.io/discord/1234942672418897960?style=flat&logo=discord)](https://discord.gg/your-invite-code)
44
[![Documentation Status](https://readthedocs.org/projects/k-wave-python/badge/?version=latest)](https://k-wave-python.readthedocs.io/en/latest/?badge=latest)
55
[![codecov](https://codecov.io/gh/waltsims/k-wave-python/graph/badge.svg?token=6ofwtPiDNG)](https://codecov.io/gh/waltsims/k-wave-python)
6-
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/waltsims/k-wave-python/master)
76

8-
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).
128

139
## Mission
1410

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.
1912

2013
## Getting started
2114

2215
![](_static/example_bmode.png)
2316

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+
```
2522

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.
3124

3225
## Installation
3326

34-
To install using [uv](https://docs.astral.sh/uv/) (recommended):
27+
Using [uv](https://docs.astral.sh/uv/) (recommended):
3528

3629
```bash
3730
uv add k-wave-python
38-
uv run python my_simulation.py
3931
```
4032

4133
Or with pip:
@@ -46,8 +38,7 @@ pip install k-wave-python
4638

4739
## Development
4840

49-
If you're enjoying k-Wave-python and want to contribute, development instructions can be
50-
found [here](https://k-wave-python.readthedocs.io/en/latest/development/development_environment.html).
41+
Development instructions can be found [here](https://k-wave-python.readthedocs.io/en/latest/development/development_environment.html).
5142

5243
## Related Projects
5344

0 commit comments

Comments
 (0)