v0.3.2

[waltsims]

What's Changed

We're excited to announce k-wave-python v0.3.2! This release brings with it many improvements and fixes listed below. Importantly, we drop support for Python 3.8 and add support for Python 3.12. We have added development documentation on testing workflows and improved the overall documentation readability. Test coverage has also been added to the project. Furthermore, David Sinden (@djps) has joined the project as our third maintainer! 🎉

Lastly, we have added a citation file to the project. If you are enjoying k-Wave-python, please cite it in your work!

Breaking Changes

• 233 drop python 38 support by @waltsims in 233 drop python 38 support #246

Improvements

• Check if color_map is usable by @faridyagubbayli in Check if color_map is usable #287
• Add code coverage by @waltsims in Add code coverage #275
• Upgrade setup-python action & use pip cache by @faridyagubbayli in Upgrade setup-python action & use pip cache #280
• Remove module name from object names in the documentation. by @waltsims in Remove module name from object names in the documentation. #285
• Remove legacy mode from write attributes by @faridyagubbayli in Remove legacy mode from write attributes #289
• create CITATION.cff proposal by @waltsims in create CITATION.cff proposal #290
• Update pyproject.toml by @waltsims in Update pyproject.toml #296
• Improve logging when checking for the presence of binaries by @faridyagubbayli in Improve logging when checking for presence of binaries #320
• Update mapgen.py to include focused annulus oneil by @djps in Update mapgen.py to include focused annulus oneil #284
• Clean up examples and add more colab buttons by @waltsims in Clean up examples and add more colab buttons #298
• Remove duplicate write_attributes_typed function by @faridyagubbayli in Remove duplicate write_attributes_typed function #318
• Add test coverage for tol_star by @faridyagubbayli in Add test coverage for tol_star #324
• Improved typing and testing for temperature dependency functions by @djps in Temperature dependencies #309
• Update make_cart_spherical_segment types to floating point values by @waltsims in Update make_cart_spherical_segment types to floating point values #315
• Add CodeCov config by @faridyagubbayli in Add CodeCov config #334
• Bump python support to 3.12 by @waltsims in Bump python support to 3.12 #267
• Update local testing workflow instructions by @waltsims in Update local testing workflow instructions #291

Fixes

• [BUG] Unclear runtime error when running GPU binary without CUDA #262 Fix stdout logic on exceptions by @waltsims in #262 Fix stdout logic on exceptions #297
• update argument types of focused_bowl_oneil by @waltsims in update argument types of focused_bowl_oneil #317
• Fix colab link for controlling the pml by @waltsims in Fix colab link for controlling the pml #333

Dependencies

• Bump pre-commit from 3.5.0 to 3.6.0 by @dependabot in Bump pre-commit from 3.5.0 to 3.6.0 #278
• Bump coverage from 7.4.0 to 7.4.1 by @dependabot in Bump coverage from 7.4.0 to 7.4.1 #294
• Bump gdown from 4.7.3 to 5.1.0 by @dependabot in Bump gdown from 4.7.3 to 5.1.0 #295
• Bump pre-commit from 3.6.0 to 3.6.1 by @dependabot in Bump pre-commit from 3.6.0 to 3.6.1 #300
• Bump furo from 2023.9.10 to 2024.1.29 by @dependabot in Bump furo from 2023.9.10 to 2024.1.29 #299
• Bump matplotlib from 3.7.2 to 3.8.3 by @dependabot in Bump matplotlib from 3.7.2 to 3.8.3 #325
• Bump scipy from 1.10.1 to 1.12.0 by @dependabot in Bump scipy from 1.10.1 to 1.12.0 #276
• Bump coverage from 7.4.1 to 7.4.3 by @dependabot in Bump coverage from 7.4.1 to 7.4.3 #330
• Bump pre-commit from 3.6.1 to 3.6.2 by @dependabot in Bump pre-commit from 3.6.1 to 3.6.2 #329

Full Changelog: v0.3.1...v0.3.2

---

This discussion was created from the release v0.3.2.