User documentation / video tutorials
Improving documentation
There are two bits of documentation: the README on the main Git repo, and the Wiki page.
-
README: currently ok, just need to make sure that the instructions are up to date, mention the contributors, and add maybe instructions for how to create a miniconda environment?
-
Wiki: This could have some more informations on the tool. For example a description of the different panels in the app, a link to the main paper (from Danny's group) which describes all the models, and links to the video tutorials.
Tutorial videos
We need a few videos that describe the functionalities and how to create different models and interact with them and understand the different plots. Bearing in mind that the interface might change in terms of its look after the videos have been made.
A list of possible videos:
-
Introduction: global overview of the different panels and sliders. Perhaps using the Tensor model.
- Begin with the top panel (choose model)
- Explain different plots
- show how moving sliders change plots
- explain microstructure plots
- move on to the acquisition panel and display HCP data
- add noise
- save data
- show saved file
- the end
-
Ball and Stick
- Here create ball+stick
- explain behaviour of each panel
- explain FOD panel
- add crossings / dispersion
- interact with glyph using acq param changing panel
-
NODDI
- csf+zeppelin+stick
- dispersion applied to both stick and zeppelin
- examine the different figures
-
SANDI
- sphere+zeppelin+stick+dispersion
- opportunity to talk about diffusion time dependence
- examine different figures
- look at cylinder (ax-caliber model)