Skip to content

Commit 9954eb3

Browse files
authored
v0.3.0 release (#225)
* Bump version number * Update README.md * Update __init__.py
1 parent f6512e7 commit 9954eb3

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

docs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# k-Wave-python
22
[![Documentation Status](https://readthedocs.org/projects/k-wave-python/badge/?version=latest)](https://k-wave-python.readthedocs.io/en/latest/?badge=latest)
33

4-
This project is a Python implementation of most of the [MATLAB toolbox k-Wave](http://www.k-wave.org/) as well as an
5-
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.
4+
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
5+
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.
66

77
## Mission
88

@@ -31,7 +31,7 @@ After installation, run the B-mode reconstruction example in the `examples` dire
3131
```bash
3232
git clone https://github.com/waltsims/k-wave-python
3333
cd k-wave-python
34-
git checkout v0.2.1
34+
git checkout v0.3.0
3535
pip install '.[example]'
3636
python3 examples/bmode_reconstruction_example.py
3737
```
@@ -46,7 +46,7 @@ This example file steps through the process of:
4646
This example expects an NVIDIA GPU by default to simulate with k-Wave.
4747

4848
To test the reconstruction on a machine with a GPU,
49-
set `RUN_SIMULATION` [on line 28 of `bmode_reconstruction_example.py`](https://github.com/waltsims/k-wave-python/blob/master/examples/bmode_reconstruction_example.py#L28)
49+
set `RUN_SIMULATION` [on line 30 of `bmode_reconstruction_example.py`](https://github.com/waltsims/k-wave-python/blob/master/examples/bmode_reconstruction_example.py#L30)
5050
to `True`, and the example will run without the pre-computed data.
5151

5252
## Development
@@ -68,4 +68,4 @@ The documentation for k-wave-python can be found [here](https://k-wave-python.re
6868

6969
## Contact
7070

71-
e-mail [walter.simson@tum.de](mailto:walter.simson@tum.de).
71+
e-mail [wsimson@stanford.edu](mailto:wsimson@stanford.edu).

kwave/__init__.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55
from os import environ
66
from pathlib import Path
77

8-
9-
VERSION = '0.2.1'
8+
# Test installation with:
9+
# python3 -m pip install -i https://test.pypi.org/simple/ --extra-index-url=https://pypi.org/simple/ k-Wave-python==0.3.0
10+
VERSION = '0.3.0'
1011
# Set environment variable to binaries to get rid of user warning
1112
# This code is a crutch and should be removed when kspaceFirstOrder
1213
# is refactored

0 commit comments

Comments
 (0)