djps / pykzk

Python implementation of axisymmetric KZK HITU simulator

pyKZK

Python implementation of version 2 of the FDA axisymmetric KZK HITU simulator which can be accessed at here.

Version 1 can be cited via¹.

Note Please see the disclaimer in the documentation regarding the terms and conditions of use, as well as the official FDA disclaimer.

Warning This is a work in progress

Table of Contents

• Getting Started
  • Dependencies
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

Getting Started

The axisymmertric KZK equation is given by:

$$ \dfrac{\partial^2 p}{\partial t^2} - c^2 \nabla^2 p + c \dfrac{\partial}{\partial t} \left[ \alpha \left( \omega \right) \ast p\left(\omega\right) \right] = \dfrac{\beta}{\rho c^2} \dfrac{\partial^2 p^2}{\partial t^2}. $$

Dependencies

This needs the following packages:

• numpy
• scipy
• matplotlib
• tqdm

They can be found in requirements.txt

Usage

From terminal

foo@bar:~$ python3 runner.py

TODO

• outputs which can be validated experimentally
• input from measurements
• testing
• actions with flake8, version
• requirements.txt

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch

foo@bar:~$ git checkout -b feature/AmazingFeature

3. Commit your Changes

foo@bar:~$ git commit -m 'Add some AmazingFeature'

4. Push to the Branch

foo@bar:~$ git push origin feature/AmazingFeature

5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Email me

Acknowledgements

• HITU Simulator [FDA]
• HITU Simulator [github]

Footnotes

1. J. E. Soneson "A User‐Friendly Software Package for HIFU Simulation" AIP Conf. Proc. 1113(1) pp 165 (2009) ↩