search

OSIPI / TF2.4_IVIM-MRI_CodeCollection

OSIPI TF2.4: IVIM MRI code collection
Apache License 2.0
9 stars 27 forks source link

Push Algorithm Analysis result plots to a static github page #46

Closed etpeterson closed 4 months ago

etpeterson commented 6 months ago

Feature description

The Algorithm Analysis workflow automatically generates some nice plots. It may be possible to automatically push those to a static github page so they're easy to view.

Describe the solution

The Figures generated in the Algorithm Analysis workflow could probably be uploaded to a simple static github page. This would be a nice way to visualize the most recent results.

Describe alternatives

No response

Additional context

I am not sure if it is possible to fully automate this. It would involve exploring the options and testing it. If it's not possible, that's a good finding as well.

Are you working on this?

None

AhmedBasem20 commented 6 months ago

@etpeterson Would love to work on this one as well!

etpeterson commented 6 months ago

Sure! I think this is fairly self explanatory. Probably just adding a push stage once the figures are generated would be enough. The harder part would be to figure out how to push it and update the page. I'm not sure it's even possible how I imagine it, but I'd like to learn more.

AhmedBasem20 commented 6 months ago

@etpeterson my approach is to create a simple HTML file where we just display all the PDFs using it. This file will be inside the Figures folder. And then we can use this action: https://github.com/JamesIves/github-pages-deploy-action to add this folder to a new gh-pages branch and then publish it to be available on this url: https://OSIPI.github.io/TF2.4_IVIM-MRI_CodeCollection

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@4.1.1
        with:
          branch: gh-pages
          folder: Figures
etpeterson commented 6 months ago

Sounds good. @oliverchampion is that site the right place for a results page to live? I presume we'd want something about the task force on the front and maybe a link to results?

oliverchampion commented 6 months ago

@ericpete @AhmedBasem20, not entirely sure what the solution would entitle. But yes, the linked page should contain TF information. @petravanhoudt --> how do we achieve that?

I think we would something similar to the DCE solution: https://osipi.github.io/DCE-DSC-MRI_TestResults/intro.html