v0.3.0
What's Changed
This release includes new interface improvements, updates to reach functional and testing parity with k-Wave v1.4.0, improved documentation, performance improvements, and fixes to k-Wave-python. We are happy to say that this release was also supported by new community contributors including @djps, @bvale1 , @talg2324! Thanks to everyone for their work and support. We hope this release accelerates your work and look forward to hearing from you.
Interface refactoring
- Refactor kSpaceFirstOrder inputs by @faridyagubbayli in #107
- Replace Array class with numpy-based Vector class by @faridyagubbayli in #118
- Vectorize variables by @faridyagubbayli in #124
k-Wave v1.4.0 changes
This release extends functional and testing coverage to k-Wave v1.4.0 MATLAB release. This includes migrating matlab functions to k-Wave-python and testing for correctness. These include:
- Python implementation of
makeCartRectby @faridyagubbayli in #126 - Add trim_zeros function and test by @waltsims in #128
- Python implementation of
trimCartPointsby @faridyagubbayli in #134 - New funcs: get_affine_matrix() and compute_linear_transform() by @faridyagubbayli in #146
- Update fwhm return values for v1.4.0 by @waltsims in #148
- Add makeCartArc and tests by @waltsims in #149
- Add get_delta_BLI and test by @waltsims in #150
- Update focus_bowl_oneil to return complex axial pressure by @waltsims in #154
- MATLAB data collector for testing kWaveArray by @faridyagubbayli in #161
- Add make_cart_bowl by @waltsims in #164
- Add make_cart_disc by @waltsims in #165
- Add make_cart_spherical_segment and test by @waltsims in #166
- Python implementation of
kWaveArray&get_off_grid_points(...)by @faridyagubbayli in #168 - Update pytest.yml to run on PRs as well by @waltsims in #197
- Add custom element by @bvale1 in #212
- Test nearest neighbor mode of resize function by @faridyagubbayli in #216
Documentation updates
We have updated and extended the documentation of k-Wave by porting the documentation to readthedocs.
- rename pages to publish_pages by @waltsims in #119
- Update README.md to fix broken docs link by @waltsims in #123
- Create ruff.yml by @waltsims in #131
- Migrate documentation to Readthedocs by @waltsims in #152
- Clean up documentation by @waltsims in #158
- Update README.md by @waltsims in #170
More examples 🍾
- Example script refactor and added testing by @waltsims in #108
- Examples/at linear array transducer by @waltsims in #174
- Example of karray source by @waltsims in #193
Performance improvements
Fixes
- Update conversion.py - fix ordering in tolStar by @djps in #172
- Clean up extra GOLDEN_ANGLES by @waltsims in #178
- Update kwave_array.py removing discretization by @djps in #195
- lower library verbosity by @talg2324 in #196
- Update workflow checkout to v4 by @waltsims in #200
- Update filters.py by @djps in #202
- Update save_to_disk_func.py - fix dtype error by @djps in #204
- fix typo by @djps in #214
Dependency updates
- Bump sphinx-toolbox from 3.2.0 to 3.4.0 by @dependabot in #99
- Bump deepdiff from 5.2.3 to 6.2.3 by @dependabot in #87
- Bump gdown from 4.6.0 to 4.6.4 by @dependabot in #110
- Bump k-Wave test version to v1.4.0 by @waltsims in #116
- Bump m2r2 from 0.3.2 to 0.3.3.post2 by @dependabot in #98
- Bump matplotlib from 3.6.3 to 3.7.1 by @dependabot in #114
- Bump sphinx-copybutton from 0.5.1 to 0.5.2 by @dependabot in #121
- Bump opencv-python from 4.7.0.68 to 4.7.0.72 by @dependabot in #112
- Bump scipy from 1.7.3 to 1.10.1 by @dependabot in #109
- Bump h5py from 3.6.0 to 3.8.0 by @dependabot in #113
- Bump gdown from 4.6.4 to 4.7.1 by @dependabot in #143
- Bump scikit-image from 0.19.3 to 0.21.0 by @dependabot in #147
- Bump deepdiff from 6.2.3 to 6.3.1 by @dependabot in #169
- Bump matplotlib from 3.7.1 to 3.7.2 by @dependabot in #179
- Bump furo from 2022.12.7 to 2023.8.19 by @dependabot in #189
- Bump h5py from 3.8.0 to 3.9.0 by @dependabot in #186
- Bump opencv-python from 4.7.0.72 to 4.8.0.76 by @dependabot in #198
New Contributors
- @djps made their first contribution in #172
- @talg2324 made their first contribution in #196
- @bvale1 made their first contribution in #212
Full Changelog: v0.2.1...v0.3.0
Contributors
djps, waltsims, and 4 other contributors