search

mind-inria / mri-nufft

Doing non-Cartesian MR Imaging has never been so easy.
https://mind-inria.github.io/mri-nufft/
BSD 3-Clause "New" or "Revised" License
51 stars 9 forks source link

Trajectory gallery: let's discuss #118

Open paquiteau opened 5 months ago

paquiteau commented 5 months ago

From the discussions in #77, #105, #106, #113, and more, It seems that a better display of the trajectories in MRI-NUFFT documentation (building on top of the amazing work of @Daval-G ). As more and more trajectories are added, the question of their discoverability is also at hand.

Technically speaking, the Sphinx Gallery seems to be a good base to work on; an inspiring example can be from matplotlib itself (https://matplotlib.org/stable/gallery/index.html)! Using sections and tagging may be a good idea as well.

Writing a script for each trajectory may be too repetitive, so maybe some templating system can be used (one solution may be to describe the trajectory in .json/.yaml and generate a .py file from it with jinja ). Also, some extra CI configuration could be helpful.

However, it is necessary first to discuss exactly what we want to display for each trajectory.

Daval-G commented 4 months ago

Overall I support the idea of generating automatically part of what we are doing by hand. The current examples are huge lists of unrelated argument descriptions, which is redundant with the documentation that just lacks the visualization part. I would see more structured examples, showing a more practical usage or discussing relation between trajectories. WDYT ?