waltsims / k-wave-python

A Python interface to k-Wave GPU accelerated binaries
https://k-wave-python.readthedocs.io/en/latest/
GNU General Public License v3.0
108 stars 32 forks source link

[ISSUE #473] Update simulation_execution_options.is_gpu_simulation() API #477

Closed waltsims closed 2 weeks ago

waltsims commented 2 months ago

close #473.

waltsims commented 2 months ago

TODOs:

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 79.64602% with 23 lines in your changes missing coverage. Please review.

Project coverage is 72.53%. Comparing base (2f5060a) to head (6f40ce0). Report is 2 commits behind head on master.

Files with missing lines Patch % Lines
kwave/options/simulation_execution_options.py 79.46% 14 Missing and 9 partials :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #477 +/- ## ========================================== + Coverage 72.41% 72.53% +0.12% ========================================== Files 46 46 Lines 6746 6805 +59 Branches 1302 1313 +11 ========================================== + Hits 4885 4936 +51 - Misses 1304 1311 +7 - Partials 557 558 +1 ``` | [Flag](https://app.codecov.io/gh/waltsims/k-wave-python/pull/477/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Walter+Simson) | Coverage Δ | | |---|---|---| | [3.10](https://app.codecov.io/gh/waltsims/k-wave-python/pull/477/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Walter+Simson) | `72.75% <79.64%> (+0.12%)` | :arrow_up: | | [3.11](https://app.codecov.io/gh/waltsims/k-wave-python/pull/477/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Walter+Simson) | `72.75% <79.64%> (+0.12%)` | :arrow_up: | | [3.12](https://app.codecov.io/gh/waltsims/k-wave-python/pull/477/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Walter+Simson) | `72.75% <79.64%> (+0.12%)` | :arrow_up: | | [3.9](https://app.codecov.io/gh/waltsims/k-wave-python/pull/477/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Walter+Simson) | `72.52% <79.64%> (+0.12%)` | :arrow_up: | | [macos-latest](https://app.codecov.io/gh/waltsims/k-wave-python/pull/477/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Walter+Simson) | `72.50% <77.87%> (+0.09%)` | :arrow_up: | | [ubuntu-latest](https://app.codecov.io/gh/waltsims/k-wave-python/pull/477/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Walter+Simson) | `72.50% <77.87%> (+0.09%)` | :arrow_up: | | [windows-latest](https://app.codecov.io/gh/waltsims/k-wave-python/pull/477/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Walter+Simson) | `72.50% <77.87%> (+0.09%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Walter+Simson#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

waltsims commented 1 month ago

I went back to basics and was able to get the desired behavior without changing the API

waltsims commented 1 month ago

I'll keep working on a better doc string

waltsims commented 1 month ago

Perhaps we should make the default value of threadbinding false thereby removing the None case. This would mean a better handling of darwin is required.

waltsims commented 3 weeks ago

@faridyagubbayli ?