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
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/master/examples/us_bmode_linear_transducer/us_bmode_linear_transducer.ipynb).
42
23
43
24
This example file steps through the process of:
44
25
1. Generating a simulation medium
45
26
2. Configuring a transducer
46
27
3. Running the simulation
47
28
4. Reconstructing the simulation
48
29
49
-
### Requirements
50
-
This example expects an NVIDIA GPU by default to simulate with k-Wave.
30
+
## Installation
31
+
32
+
To install the most recent build of k-Wave-python from PyPI, run:
51
33
52
-
To test the reconstruction on a machine with a GPU,
53
-
set `RUN_SIMULATION`[on line 29 of `us_bmode_linear_transducer.py`](https://github.com/waltsims/k-wave-python/blob/6d2ee982bece84fc6980da99b23600f5675d2fc5/examples/us_bmode_linear_transducer/us_bmode_linear_transducer.py#L29)
54
-
to `True`, and the example will run without the pre-computed data.
34
+
```bash
35
+
pip install k-wave-python
36
+
```
37
+
38
+
After installing the Python package, the required binaries will be downloaded and installed the first time you run a
0 commit comments