{"id":29276594,"url":"https://github.com/waltsims/k-wave-python","last_synced_at":"2026-02-17T09:02:18.777Z","repository":{"id":37262351,"uuid":"477094400","full_name":"waltsims/k-wave-python","owner":"waltsims","description":"A Python interface to k-Wave GPU accelerated binaries","archived":false,"fork":false,"pushed_at":"2025-06-16T22:24:41.000Z","size":11671,"stargazers_count":148,"open_issues_count":66,"forks_count":42,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-06-28T06:48:55.193Z","etag":null,"topics":["acoustics","gpu","kwave","neuroscience","python","simulation","ultrasound","wave-equation"],"latest_commit_sha":null,"homepage":"https://k-wave-python.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/waltsims.png","metadata":{"files":{"readme":"docs/README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-04-02T15:27:23.000Z","updated_at":"2025-06-25T14:49:23.000Z","dependencies_parsed_at":"2023-12-23T16:42:56.825Z","dependency_job_id":"78383ff1-f273-4de9-a915-092feba43c30","html_url":"https://github.com/waltsims/k-wave-python","commit_stats":{"total_commits":347,"total_committers":12,"mean_commits":"28.916666666666668","dds":0.7089337175792507,"last_synced_commit":"cf277a60e3a3176ec546762c2ee59c06d4cd14f5"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/waltsims/k-wave-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waltsims%2Fk-wave-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waltsims%2Fk-wave-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waltsims%2Fk-wave-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waltsims%2Fk-wave-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/waltsims","download_url":"https://codeload.github.com/waltsims/k-wave-python/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/waltsims%2Fk-wave-python/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263712543,"owners_count":23500060,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["acoustics","gpu","kwave","neuroscience","python","simulation","ultrasound","wave-equation"],"created_at":"2025-07-05T08:38:39.342Z","updated_at":"2026-02-17T09:02:18.772Z","avatar_url":"https://github.com/waltsims.png","language":"Python","funding_links":[],"categories":["General Tools"],"sub_categories":[],"readme":"# k-wave-python\n\n[![Support](https://img.shields.io/discord/1234942672418897960?style=flat\u0026logo=discord)](https://discord.gg/your-invite-code)\n[![Documentation Status](https://readthedocs.org/projects/k-wave-python/badge/?version=latest)](https://k-wave-python.readthedocs.io/en/latest/?badge=latest)\n[![codecov](https://codecov.io/gh/waltsims/k-wave-python/graph/badge.svg?token=6ofwtPiDNG)](https://codecov.io/gh/waltsims/k-wave-python)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/waltsims/k-wave-python/master)\n\nThis project is a Python implementation of v1.4.0 of the [MATLAB toolbox k-Wave](http://www.k-wave.org/) as well as an\ninterface to the pre-compiled v1.3 of k-Wave simulation binaries, which support NVIDIA sm 5.0 (Maxwell) to sm 9.0a (Hopper) GPUs.\n\n## Mission\n\nWith this project, we hope to increase the accessibility and reproducibility of [k-Wave](http://www.k-wave.org/) simulations\nfor medical imaging, algorithmic prototyping, and testing. Many tools and methods of [k-Wave](http://www.k-wave.org/) can\nbe found here, but this project has and will continue to diverge from the original [k-Wave](http://www.k-wave.org/) APIs\nto leverage pythonic practices.\n\n## Getting started\n\n![](_static/example_bmode.png)\n\nA 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/HEAD/examples/us_bmode_linear_transducer/us_bmode_linear_transducer.ipynb).\n\nThis example file steps through the process of:\n 1. Generating a simulation medium\n 2. Configuring a transducer\n 3. Running the simulation\n 4. Reconstructing the simulation\n\n## Installation\n\nTo install the most recent build of k-Wave-python from PyPI, run:\n\n```bash\npip install k-wave-python\n```\n\u003e **Note for MacOS:**\n\u003e \n\u003e k-wave-python offers initial support for MacOS, but you will need to install the following dependencies using the [brew package manager](https://docs.brew.sh/Installation) along with the Python package:\n\u003e ```bash\n\u003e brew install fftw hdf5 zlib libomp\n\u003e ```\nAfter installing the Python package, the required binaries will be downloaded and installed the first time you run a\nsimulation.\n\n## Development\n\nIf you're enjoying k-Wave-python and want to contribute, development instructions can be\nfound [here](https://k-wave-python.readthedocs.io/en/latest/development/development_environment.html).\n\n## Related Projects\n\n1. [k-Wave](https://github.com/ucl-bug/k-wave): A MATLAB toolbox for the time-domain simulation of acoustic wave fields.\n2. [j-wave](https://github.com/ucl-bug/jwave): Differentiable acoustic simulations in JAX.\n3. [ADSeismic.jl](https://github.com/kailaix/ADSeismic.jl): a finite difference acoustic simulator with support for AD\n   and JIT compilation in Julia.\n4. [stride](https://github.com/trustimaging/stride): a general optimisation framework for medical ultrasound tomography.\n\n## Documentation\n\nThe documentation for k-wave-python can be found [here](https://k-wave-python.readthedocs.io/en/latest/).\n\n## Citation\n```bibtex\n@software{k-Wave-Python,\nauthor = {Yagubbbayli, Farid and Sinden, David and Simson, Walter},\nlicense = {GPL-3.0},\ntitle = {{k-Wave-Python}},\nurl = {https://github.com/waltsims/k-wave-python}\n}\n```\n## Contact\n\ne-mail [wsimson@stanford.edu](mailto:wsimson@stanford.edu).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaltsims%2Fk-wave-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwaltsims%2Fk-wave-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwaltsims%2Fk-wave-python/lists"}