flywheel.md
1 # Flywheel 2 3 ## Web site 4 [fw.mrrc.upmc.edu](https://fw.mrrc.upmc.edu/) hosts the MRRC's flywheel instance. 5 6 For the moment[^pending], access is restricted to within the UPMC intranet. 7 You must either be in a UPMC building or access with a web browser launched from [myapps.upmc.edu](https://myapps.upmc.edu). 8 9 [^pending]: (Mar 2024, pending UPMC IT approval for global web accesses) 10 11 ## Usage 12 13 See [docs.flywheel.io](https://docs.flywheel.io). 14 15 16 ### CLI 17 18 The scanner connector should automatically "ingest" all study sessions. But the CLI tool can easily upload additional data! 19 20 ``` 21 fw ingest dicom --include 'MR.*' -vd 2024.02.15-08.50.45/11998_20240215/ luna wpc-8620-habit 22 ``` 23 24 This example is tailored to work with MRRC Prisma DICOMS. The command uploads the session folder `2024.02.15-08.50.45/11998_20240215/` including sub-directories for all acquisitions for that visit to the `luna` group's project `wpc-8620-habit`. Notably, we need to specify the dicom pattern as anything starting with `MR`. 25 26 ## Gears 27 "Gears" are docker containers that can be run manually on the web interface or automatically via ["gear rules."](https://docs.flywheel.io/User_Guides/user_project_gear_rules/). 28 29 Flywheel curates publicly available gears on the [Gear Exchange](https://docs.flywheel.io/hc/en-us/articles/4410774982419-The-Gear-Exchange). 30 We can also create custom gears for bespoke pipelines. 31 32 ## Authentication 33 34 Flywheel authentication uses pitt.edu credentials through "University Credential via CILogin." 35 MRRC Flywheel admins need your primary/non-aliased case sensitive (likely all caps) pitt email addresses to match CILogin and grant access. 36 37 You can find or confirm your Pitt account name following https://authtest.flywheel.io using "University Credentials" for "University of Pittsburgh." 38 After authenticating, the "Id Token" section's "email" field is the case sensitive email flywheel needs to give you access. Screenshots below. 39 40  41 42 <!-- also my profile in pitt -->