Skip to content

Template Project / Revamped Readme (rtFIN)

Latest
Compare
Choose a tag to compare
@PaulScotti PaulScotti released this 12 Oct 14:01
· 7 commits to master since this release
82bc250

Major changes made in time for rtFIN2022 conference:

  • Template project meant to be used as a template for users to wrap their own projects--heavily commented and walks user through implementing the Mennen et al. 2021 pipeline with BIDS Incrementals and support for OpenNeuro replay
  • Separate instructions for Docker vs local conda environment
  • Installation instructions and template project tutorial linked together to demonstrate RT-Cloud usage
  • Install instructions now correctly account for different operating systems, with caveats for Mac M1s + Windows
  • Components have been renamed (data_analyser, data_streamer, analysis_listener) to improve clarity. The corresponding shell scripts have been renamed as well but the original files are untouched so previous users do not need to modify anything; the renamed shell scripts are identical to the original shell scripts aside from the filename.
  • New picture depicting the communication of RT-Cloud components in Readme
  • Quickstart Docker demo to very quickly get a user to test out the sample project in one line of code
  • setResultsDict now conveniently outputs jsons to a default folder (this is demonstrated in the template project)
  • More specific instructions now provided in the run-in-docker markdown file
  • Replaying OpenNeuro section directs user to try to implement changes to the template project which is built to accommodate such Replay
  • New section: Sharing your RT-Cloud pipeline as a Docker image