Skip to content

Commit

Permalink
v0.3.4 release (#430)
Browse files Browse the repository at this point in the history
* bump version to 3.4

* Update README.md

* delete requirements
  • Loading branch information
waltsims authored Jul 9, 2024
1 parent 98b0d26 commit 63055b4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 26 deletions.
35 changes: 10 additions & 25 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,43 +15,28 @@ for medical imaging, algorithmic prototyping, and testing. Many tools and method
be found here, but this project has and will continue to diverge from the original [k-Wave](http://www.k-wave.org/) APIs
to leverage pythonic practices.

## Installation

To install the most recent build of k-Wave-python from PyPI, run:

```bash
pip install k-wave-python
```

After installing the Python package, the required binaries will be downloaded and installed the first time you run a
simulation.

## Getting started

![](_static/example_bmode.png)

After installation, run the B-mode reconstruction example in the `examples` directory of the repository:

```bash
git clone https://github.com/waltsims/k-wave-python
cd k-wave-python
git checkout v0.3.3
pip install '.[example]'
python3 examples/us_bmode_linear_transducer/us_bmode_linear_transducer.py
```
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).

This example file steps through the process of:
1. Generating a simulation medium
2. Configuring a transducer
3. Running the simulation
4. Reconstructing the simulation

### Requirements
This example expects an NVIDIA GPU by default to simulate with k-Wave.
## Installation

To install the most recent build of k-Wave-python from PyPI, run:

To test the reconstruction on a machine with a GPU,
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)
to `True`, and the example will run without the pre-computed data.
```bash
pip install k-wave-python
```

After installing the Python package, the required binaries will be downloaded and installed the first time you run a
simulation.

## Development

Expand Down
2 changes: 1 addition & 1 deletion kwave/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

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

# Constants and Configurations
URL_BASE = "https://github.com/waltsims/"
Expand Down

0 comments on commit 63055b4

Please sign in to comment.