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

Get parameter visualization back into the documentation #991

Open
handwerkerd opened this issue Oct 24, 2023 · 1 comment
Open

Get parameter visualization back into the documentation #991

handwerkerd opened this issue Oct 24, 2023 · 1 comment
Labels
documentation issues related to improving documentation for the project effort: medium Theoretically <40h total work impact: medium Improves code/documentation functionality for some users priority: medium Should get addressed soon

Comments

@handwerkerd
Copy link
Member

Summary

@jsheunis made a great interactive interface for viewing parameter space options at: https://me-fmri-overview.herokuapp.com/ I think that's been down for a while. We should make sure that info is in the docs

Additional Detail

This was originally discussed in #552 and addressed in #745 by adding a link to the herokuapp site.

Next Steps

  • Find out If @jsheunis has the time to get that site back up and keep it maintained
  • Otherwise, we should design static figures based on the underlying data and add them directly into the tedana documentation.
@handwerkerd handwerkerd added documentation issues related to improving documentation for the project priority: medium Should get addressed soon effort: medium Theoretically <40h total work impact: medium Improves code/documentation functionality for some users labels Oct 24, 2023
@jsheunis
Copy link
Contributor

Yup heroku closed down all of their free app services...

There are two ways I can think of to bring the figures back up with the least effort:

  • convert them to PlotlyJS figures (currently they're created with Dash i.e. python, but using the plotly API) and host them as a standalone single-page static site via github pages
  • convert them to PlotlyJS figures and embed these in the RST files of tedana's docs

The former option would be most in line with what we had already, but the latter shouldn't be a problem. I'm happy to do either. Time would be the main constraint but I can get to it somewhere during the next month.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to improving documentation for the project effort: medium Theoretically <40h total work impact: medium Improves code/documentation functionality for some users priority: medium Should get addressed soon
Projects
None yet
Development

No branches or pull requests

2 participants