Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Trajectory gallery: let's discuss #118

Open
paquiteau opened this issue May 26, 2024 · 1 comment
Open

Trajectory gallery: let's discuss #118

paquiteau opened this issue May 26, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation trajectories Issues concerning Non cartesian trajectories

Comments

@paquiteau
Copy link
Member

paquiteau commented May 26, 2024

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.

@paquiteau paquiteau added documentation Improvements or additions to documentation trajectories Issues concerning Non cartesian trajectories labels May 26, 2024
@Daval-G
Copy link
Collaborator

Daval-G commented Jun 5, 2024

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 ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation trajectories Issues concerning Non cartesian trajectories
Projects
None yet
Development

No branches or pull requests

2 participants