No "add_custom_element" function in kWaveArray

[bvale1]

There appears to be no "add_custom_element" function in the kWaveArray class which should allow the user to define their own integration points for a custom array element

[bvale1]

I've added this function in my own branch of k-wave-python and started using it, happy to write a test as well and submit a pull request :)

[waltsims]

Hey!

Thanks for looking into this. A PR would be great. Just in time for our planned v0.3.0 release.

Best,
Walter

[bvale1]

I've added a few lines to KWaveArray_test.py that should test the add_custom_element function but I'm not entirely sure how to run the tests, could you assist?

[waltsims]

Hey,

The pattern we use is to write a dataCollector where we save artifacts in Matlab of a running example.

For you this would mean adding some test examples to collect_kWaveArray that makes a custom element. Then in the respective python file kWaveArray_test.py updating the python code to execute the same operations and assert equality between the outputs.

For this pattern, we use the helper classes, TestRecorder in Matlab, and TestRecordReader in python.

To run the test suite locally, one can run run_all_collectors in MATLAB and then run the python test_suite with pytest.

If you open a PR on your branch, this will also be done in the CI to test your code. This might be helpful if you don't have MATLAB installed.

Thanks for contributing to the project, and I hope this helps. If something is not clear, let me know.

Best,
Walter

[bvale1]

Hi Walter,

I've written a couple of cases (one for 2d and one for 3d) I've just had some issues running them, I changed the Dockerfile from 'COPY README.md .' to 'COPY docs docs/' in order to build it on my machine. I currently have a problem running the collectors in MATLAB 'unrecognized function or variable focusedBowlONeil'. I can have another crack at it tomorrow :)

Best wishes,
Billy.

[waltsims]

Thanks for updating the DockerFile. I last used it quite some time ago. Please add those changes to your PR!

[waltsims]

closed with #212