search

OSIPI / TF2.4_IVIM-MRI_CodeCollection

OSIPI TF2.4: IVIM MRI code collection
Apache License 2.0
9 stars 27 forks source link

adding jupyter notebook usage code and IVIM analysis #65

Closed merelvdthiel closed 3 weeks ago

merelvdthiel commented 3 months ago

Describe the changes you have made in this PR

Adding of jupyter notebook and adaptations of readme to refer to the notebook

Link this PR to an issue [optional]

Fixes #ISSUE-NUMBER

Checklist

oliverchampion commented 3 months ago

Also, you have merged a .jpynb_checkpoints folder. Is this necessary or is this something that we can put on the ignore list?

oliverchampion commented 3 months ago

I see that the Notebook was run, with results in the commit. As these images will be stored in the Git history, and the history will grow every time someone changes the notebook, this can cause issues in the future. For code commits, we have told users not to run the jupyter notebook. One way of doing so can be seen here: https://gist.github.com/33eyes/431e3d432f73371509d176d0dfb95b6e. On the other hand, as this is an educational notebook it may be desirable that the output is visible. That said, I could only see the output after downloading and opening in my pycharm copy. This makes it hard for new users with little experience in Python. Possibly we could host the Jupyter notebook on GoogleColab instead, with all output visible and runnable in a browser. Let's discuss next session.

oliverchampion commented 1 month ago

Hey! If you could add the notebook to .gitignore file such that it is not updated when people run it locally, than I can merge this request.

merelvdthiel commented 1 month ago

Also, you have merged a .jpynb_checkpoints folder. Is this necessary or is this something that we can put on the ignore list?

We put it on the git ignore list now. The notebook itself we also put on the git ignore list