search

niivue / ipyniivue

A WebGL-powered Jupyter Widget for Niivue based on anywidget
BSD 2-Clause "Simplified" License
25 stars 8 forks source link

Bug fix, linting, comments in example notebooks. #26

Closed christian-oreilly closed 1 year ago

christian-oreilly commented 1 year ago

I added some documentation.

When deployed on Google Colab through the button provided by the README, the other files from the package are not accessible. The consequence of this is that file './demo_images/mni152.nii.gz' is also not available, and the example fails. For now, I replaced this path with a nibabel sample files. The volume is probably less pretty, but it works. Moving forward, a systematic way to deal with demo and test files need to be defined so that these files are available in the various use case we want to be able to cover.

I merged the addobject notebook with the introduction notebook.

I would have added an example with the visualization of MNE sources, but this will need to wait the resolution of #23.

The notebook on custom_code is current not very convincing giving the issue #24

AnthonyAndroulakis commented 1 year ago

Thank you for the pull request - sorry for the delayed response.

Looks good to me. I like your solution of using nibabel sample files. I agree, we'll need to work on a proper way to handle demo and test files. Also, good idea to merge addobject into the introduction notebook.