DOC: Documentation for Eddymotion Python Module Usage

[esavary]

This pull request adds instructions on integrating Eddymotion functionalities with custom diffusion-weighted imaging (DWI) data within Python modules. By following these steps, users can incorporate Eddymotion functionnalities into their projects. Closes issue #126.

[esavary]

There are some linting errors spotted by Ruff in the CircleCI routine that are not related to changes in this PR but rather to modifications made previously in update_authors.py. If it's okay, I can write an issue or fix them in a separate PR.

[jhlegarreta]

#169 (comment) should be fixed by PR #172.

[arokem]

Just a small suggestion to make it clear that this is not limited to modules that get imported elsewhere, but can also be used in "scripting"

[oesteban]

I did not have time to render it locally, so my review is partial. Left a few comments.

[esavary]

I did not have time to render it locally, so my review is partial. Left a few comments.

Thanks, are you planning to conduct a more extensive review later when you have more time, or should we consider merging the PR and make improvements in a subsequent PR?

[oesteban]

should we consider merging the PR and make improvements in a subsequent PR?

I don't see any benefit to this route -- IMHO, this doesn't seem that urgent to merge and rework as we go.

I cannot review it now, but I will try to find the time.

[effigies]

As a non-user, I think this reads well. It would be nice if there were a link to some data (small enough to run reasonably quickly) I could download to test that all of the commands work as advertised.

[esavary]

As a non-user, I think this reads well. It would be nice if there were a link to some data (small enough to run reasonably quickly) I could download to test that all of the commands work as advertised.

Thanks, I've added a note to retrieve an example of DWI data from OSF in 4762fad. However, I'm not sure if there might be a better choice of test data, perhaps something lighter. This is one of the datasets I'm currently using locally to test the code.

[effigies]

With a couple of small changes (I pushed directly), I was able to follow along.