Skip to content

Commit 63055b4

Browse files
authored
v0.3.4 release (#430)
* bump version to 3.4 * Update README.md * delete requirements
1 parent 98b0d26 commit 63055b4

File tree

2 files changed

+11
-26
lines changed

2 files changed

+11
-26
lines changed

docs/README.md

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,43 +15,28 @@ for medical imaging, algorithmic prototyping, and testing. Many tools and method
1515
be found here, but this project has and will continue to diverge from the original [k-Wave](http://www.k-wave.org/) APIs
1616
to leverage pythonic practices.
1717

18-
## Installation
19-
20-
To install the most recent build of k-Wave-python from PyPI, run:
21-
22-
```bash
23-
pip install k-wave-python
24-
```
25-
26-
After installing the Python package, the required binaries will be downloaded and installed the first time you run a
27-
simulation.
28-
2918
## Getting started
3019

3120
![](_static/example_bmode.png)
3221

33-
After installation, run the B-mode reconstruction example in the `examples` directory of the repository:
34-
35-
```bash
36-
git clone https://github.com/waltsims/k-wave-python
37-
cd k-wave-python
38-
git checkout v0.3.3
39-
pip install '.[example]'
40-
python3 examples/us_bmode_linear_transducer/us_bmode_linear_transducer.py
41-
```
22+
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).
4223

4324
This example file steps through the process of:
4425
1. Generating a simulation medium
4526
2. Configuring a transducer
4627
3. Running the simulation
4728
4. Reconstructing the simulation
4829

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:
5133

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
39+
simulation.
5540

5641
## Development
5742

kwave/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
# Test installation with:
1111
# python3 -m pip install -i https://test.pypi.org/simple/ --extra-index-url=https://pypi.org/simple/ k-Wave-python==0.3.0
12-
VERSION = "0.3.3"
12+
VERSION = "0.3.4"
1313

1414
# Constants and Configurations
1515
URL_BASE = "https://github.com/waltsims/"

0 commit comments

Comments
 (0)