Metadata-Version: 2.1
Name: k-Wave-python
Version: 0.0.0a1
Summary: Acoustics toolbox for time domain acoustic and ultrasound simulations in complex and tissue-realistic media.
Home-page: https://github.com/waltsims/k-wave-python
Author: Farid Yagubbayli
Author-email: farid.yagubbayli@tum.de
Maintainer: Walter Simson
Maintainer-email: walter.simson@tum.de
License: UNKNOWN
Project-URL: Original Project Page, http://www.k-wave.org/
Project-URL: Github Repo, https://github.com/waltsims/k-wave-python
Project-URL: Documentation, https://waltersimson.com/k-wave-python/
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: ~=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# k-Wave-python

This project is a Python interface to the [k-Wave simulation binaries](http://www.k-wave.org/download.php).

The documentation can be found [here](http://waltersimson.com/k-wave-python/)
## Installation

```commandline
git clone https://github.com/waltsims/k-wave-python
cd k-wave-python
python setup.py install
```

## Getting started
![](docs/images/example_bmode.png)

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

```bash
pip install -r example_requirements.txt
python3 examples/bmode_reconstruction_example.py
```

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

## Development

If your're enjoying k-Wave-python and want to contribute, development instructions can be found [here](https://waltersimson.com/k-wave-python/development/development_environment.html).


