Add example as a notebook: example_na_controlling_the_pml

[faridyagubbayli]

Adds our first Colab-runnable example 🎉

Migrates an example (example_na_controlling_the_pml) from Matlab to Python as a Jupyter notebook. Changes also include a demonstration of equality between Matlab and Python outputs. A modified Matlab script is available for collecting Matlab outputs.

Note: "Run in Colab" button will be functional upon merging this PR.

[waltsims]

Hey Farid!

Amazing PR. The output plot of the notebook looks like it needs to be fixed.

[waltsims]

This might be the method we need to fix this example. I am leaving this comment for myself later.

[waltsims]

This might be the method we need to fix this example. I am leaving this comment for myself later.

This indeed worked.

[waltsims]

@faridyagubbayli please check again that get_color_map works as intended. perhaps we could make a test so we can test it in all python versions? I was having issues with python 3.8.

[waltsims]

Please make sure the example follows the passing proper usage and we're good!

[waltsims]

This might be the method we need to fix this example. I am leaving this comment for myself later.

This should be updated in the logic kWaveSimulation. There is an option there but it seems the logic doesn't work atm. Same in kwave? Let's update this logic on the next point release.

[faridyagubbayli]

@waltsims going to merge this soon, please let me know if I should not. I agree that we can fix the method you linked in the next point release.

[waltsims]

Im happy if you change the color map in the notebook and add 'update colormap' as an enhancement for the next point release. All examples will need it!

[waltsims]

I made the change. Just test the notebook please.

[faridyagubbayli]

@waltsims thanks for making the change! I tested the notebook. Although colors are different, everything seems fine. Going to merge.