Let's use this branch & PR to a) periodically update the documentation within waveorder module, and b) update notebooks that illustrate how to use waveOrder library. In the process, we will notice the need to refactor parameters or methods to improve readability. Refactors focused on readability are perfectly fine to do on this branch. Any refactor that affects functionality should be on a separate branch/PR and tested against recOrder.
Let's use this branch & PR to a) periodically update the documentation within waveorder module, and b) update notebooks that illustrate how to use waveOrder library. In the process, we will notice the need to refactor parameters or methods to improve readability. Refactors focused on readability are perfectly fine to do on this branch. Any refactor that affects functionality should be on a separate branch/PR and tested against recOrder.