Skip to content

Commit 8eff587

Browse files
authored
bump version number and update readme (#335)
1 parent 6d2ee98 commit 8eff587

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ After installation, run the B-mode reconstruction example in the `examples` dire
3333
```bash
3434
git clone https://github.com/waltsims/k-wave-python
3535
cd k-wave-python
36-
git checkout v0.3.1
36+
git checkout v0.3.2
3737
pip install '.[example]'
3838
python3 examples/us_bmode_linear_transducer/us_bmode_linear_transducer.py
3939
```
@@ -48,7 +48,7 @@ This example file steps through the process of:
4848
This example expects an NVIDIA GPU by default to simulate with k-Wave.
4949

5050
To test the reconstruction on a machine with a GPU,
51-
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)
51+
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)
5252
to `True`, and the example will run without the pre-computed data.
5353

5454
## Development
@@ -68,6 +68,15 @@ found [here](https://k-wave-python.readthedocs.io/en/latest/development/developm
6868

6969
The documentation for k-wave-python can be found [here](https://k-wave-python.readthedocs.io/en/latest/).
7070

71+
## Citation
72+
```bibtex
73+
@software{k-Wave-Python,
74+
author = {Yagubbbayli, Farid and Sinden, David and Simson, Walter},
75+
license = {GPL-3.0},
76+
title = {{k-Wave-Python}},
77+
url = {https://github.com/waltsims/k-wave-python}
78+
}
79+
```
7180
## Contact
7281

7382
e-mail [wsimson@stanford.edu](mailto:wsimson@stanford.edu).

kwave/__init__.py

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

99
# Test installation with:
1010
# python3 -m pip install -i https://test.pypi.org/simple/ --extra-index-url=https://pypi.org/simple/ k-Wave-python==0.3.0
11-
VERSION = '0.3.1'
11+
VERSION = '0.3.2'
1212
# Set environment variable to binaries to get rid of user warning
1313
# This code is a crutch and should be removed when kspaceFirstOrder
1414
# is refactored

0 commit comments

Comments
 (0)