Welcome to the new and improved Flywheel Documentation Portal! Please let us know how we're doing. Provide Feedback.
logo
Flywheel Documentation
Index
Initializing search
    • Home
    • User Guides
    • Clinical
    • Developer Guides
    • Data Transfer
    • CLI
    • Administration
    • Release Notes
    • Forum
    • Support
    • Home
    • User Guides
      • Acquisitions
      • Add and Edit Custom Metadata
      • Adding Attachments
      • Advanced Search
      • Analysis Tab
      • Analysis Gears
      • Annotating Data
      • Automated Quality Assurance MRIQC Gear
      • Basic Search
      • Best Practices
      • OHBM 2020Automating Bids Workflow with Flywheel
      • Export a Project in BIDS Format
      • Flywheel + BIDS Getting Started
      • Importing Existing BIDS Data
      • Storing BIDS Sidecars
      • BIDS Study Design Spreadsheet
      • Webinar BIDS Templating
      • Viewing BIDS Metadata in Flywheel
      • BrainBrowser Info
      • Building a MATLAB Gear
      • Creating and Using Collections
      • Creating Custom Forms with Form Builder
      • Custom Metadata - Adding/Editing
      • Customer Success Story
      • Data Classification
      • Data Exchange
      • Data Views
      • Data Views Available Fields and Technical Specifications
      • Dcm2niix Troubleshooting
      • De-Identification Overview
      • Deleting Data
      • Deleting Flywheel Data
      • Discovery Dashboard Quick Start
      • Downloaded Files with .MISSING Extension
      • Downloading a File from the Web UI
      • Downloading an Entire Project from the Web UI
      • Downloading Analysis Outputs Using the Flywheel UI and SDK
      • Downloading Sessions or Acquisitions from Web UI
      • File Types in Flywheel
      • File Versioning
      • Filtering Data
      • Finding Data in Flywheel
      • Finding Uploaded Data
      • Flywheel AML
      • Flywheel Gears
      • Flywheel Notebooks User Guide
      • Flywheel Webinar FlyQL and Advanced Searching in the SDK
      • FreeSurfer License File to Run a FreeSurfer or fMRIPrep Gear
      • Gear Exchange
      • Gear Rule Processing Details
      • Gear Rules
      • Types of Gears
      • Gear Type and Gear Access
      • Gear Versioning
      • How to Move a Session to a Different Project
      • How to Replace Legacy API Keys
      • Ignoring Certain Images in Bids
      • Illegal Characters
      • Including a FreeSurfer License File to Run a FreeSurfer or fMRIPrep Gear
      • Installation of Form Builder and Viewer
      • Introduction to a SDK Gear
      • Introduction to Read Tasks
      • Minimum Required DICOM Tags for Functionality
      • Moving a Session to a Different Project
      • Moving An Acquisition
      • Moving Sessions
      • Obtaining an Error File when Debugging fMRIPrep Failures
      • Prioritizing Jobs and Gear Execution
      • Project Tab
      • Provenance Tab
      • Running a Flywheel Job Locally with Docker
      • Running an Analysis Gear on a Subject
      • Running Gears as a Batch
      • Search
      • Searching Custom Metadata Fields
      • Selecting Data in Flywheel
      • Session Tab
      • Site Wide Project Catalog
      • Smart Copy
      • Study Participant Project Report
      • Subject Tab
      • Subject View
      • Tag Management
      • The Flywheel hierarchy
      • Timestamps
      • Unzipping dcm.zip in a Downloaded Flywheel Project
      • Use Gear Rules to Automate Data Preprocessing
      • Using Custom Project Info to Define Custom Classifications
      • Using the Jobs Log, Views, Tabs and Actions
      • Using University Credentials to Sign In
      • Utility Gears
      • Validated Instance Audit Trail
      • Validated Instance Delete Reason
      • Validated Instance MFA Digital Signature
      • Validated Instance Overview
      • Validated Instance Project Locking
      • Webinar Series Intro to Flywheel
      • Webinars
      • Welcome to Flywheel
    • Clinical
      • Find Data in Flywheel
        • Annotating Data
        • Viewer Indexing Errors
        • Minimum Required DICOM Tags for Functionality
        • Revert to the Legacy DICOM/NIfTI Viewer
        • Supported SOP Class UID Values
        • The OHIF Config File
        • View and Annotate Images
        • Creating a Viewer Protocol
        • OHBM 2020: Automating BIDS Workflow with Flywheel
        • OHBM 2020: Data Curation and Machine Learning Presentation
        • OHBM 2020: Open Science, Reuse, and Reproducibility
      • Grant Resources
    • Developer Guides
      • Gearify the BIDS app template
      • BIDS Curation Tutorial Part 1 Preparing Data
      • BIDS Curation Tutorial Part 2 Running Relabeling
      • BIDS Curation Tutorial Part 3 Running BIDS Curation
      • BIDS Curation Tutorial Part 4 Curation Reports
      • BIDS Curation Tutorial Part 4 Curation Reports
      • BIDS Curation Tutorial Part 5 Fieldmaps and IntendedFor
      • BIDS Curation Tutorial Part 6 Project Curation Template
      • BIDS Curation Tutorial Part 5 Fieldmaps and IntendedFor
      • Differences Between the Flywheel and BIDS Hierarchy
      • How the BIDS Template Engine Processes Data
      • The BIDS Template File
      • Update a BIDS app gear
      • Extension Applications
      • Flywheel Webinar FlyQL and Advanced Searching in the SDK
      • Gear Building Tutorial
      • Gear Building Tutorial Part 1 Developing Gears
      • Gear Building Tutorial Part 2 Creating Your First Gear
      • Gear Building Tutorial Part 3 The Flywheel Environment
      • Gear Building Tutorial Part 4 The Run Script
      • Gear Building Tutorial Part 5 The Manifest
      • Gear Building Tutorial Part 6 The Dockerfile
      • Gear Building Tutorial Part 7 Running a Gear Locally
      • Gear Building Tutorial Part 8 Logging
      • Gear Building Tutorial Part 9 Debugging
      • Gear Exchange
      • Gear Permissions
      • Gear Rules with SDK Gears
      • Gear Specification
      • Gear Versioning
      • Introduction to an SDK Gear
      • Obtaining the Error File When Debugging fMRIPrep Failures
      • Webinar Series Finding Material with Python SDK
      • Webinar Series Flywheel SDK to Create
      • Webinar Series Intro to Flywheel Gear Building
      • Webinar Series Intro to the Flywheel SDK
      • Getting Data In
        • Ad hoc Upload
        • Bulk Import & Upload
          • How to Run a Bulk Import
          • Mapping Rules
          • Duplicate Handling
          • Reference-in-Place
        • DICOM Connector
          • Capturing Data Directly from MR Scanner
          • Naming Acquisitions for Automated Classification
          • Import Flywheel Data from a DIMSE Peer Application
        • (Legacy) DICOM Upload
          • Detect Duplicate Files When Uploading
          • Step 1: Create a Template for File Upload
          • Step 2: De-identify Data
          • Step 3: Adding Additional Settings
          • Step 4: Run the Command
      • Getting Data Out
        • Bulk Export
    • CLI
        • Installation
        • Updating
        • Configuration File
        • Usage and Examples
        • fw deid
        • fw download
        • fw export bids
        • fw ingest
            • Detecting Duplicate Files with fw ingest
            • Audit Log
            • Use the Flywheel Cluster to Ingest Data Faster
            • Setting Up S3 Credentials for Ingest Cluster
          • bids
          • dicom
            • Importing DICOM Files Using the Flywheel CLI
            • CLI Reference Guide: Import DICOM
          • folder
            • Importing a Structured Folder of Imaging Data with the CLI
          • project
          • template
            • Additional Template Examples
            • Config File for the Ingest Template CLI Command
            • Create a Template
            • De-identifying Data during Ingest
            • Include/Exclude Settings
        • fw ls
        • fw sync
          • Export Templates
        • fw upload
        • Finding Logs
        • Login Issues
        • Startup Error
        • Temporary Storage Location
        • Support for MacOS 10.15 Catalina
    • Administration
        • Add Users
        • Delete Users
        • Roles & Permissions Overview
        • Create Custom Roles
        • Access Logs
        • Manage Site Mode
        • Adding Institutional Collaborators
        • ORCID Account Configuration
        • Troubleshooting Authentication
        • Overview
        • Creating API Keys
      • Data Backup
      • Deidentification
        • Create a De-ID Profile
        • De-id Profile Transformation Reference Guide
        • De-identification Profiles
        • Enable a De-id Profile for a Project, Group, or Site
        • How to De-identify DICOM Files Using the DICOM Uploader
        • How to De-identify Private DICOM Tags
        • Create a De-id Profile
        • De-Identify DICOM Files Using the CLI
        • Interfaces - Devices, DICOM Peers, External Storage
        • External Storage Configuration
        • Overview
        • Adding a New Device
        • The "Use Connector's Pre-configured Credentials" Option
      • Extension Applications
        • Gear Menu Organization
        • Gear Rule Templates
        • Setting Gear Access Permissions
        • Delete Gears
        • Software and Computing Requirements for HPC Client System
        • Using Pre-built Singularity Images (.sif) with HPC
        • Create a Group and Project
        • Create a Project
        • Project Template
        • Session Templates
        • Data Views
        • Site Bookmarks
        • What is the Unknown Group and Unsorted Project?
        • Discovery Control Panel User Guide
        • Discovery Control Panel Configuration
        • Discovery to Core Data Export
    • Release Notes
        • Deprecation of Legacy API Keys
        • Gear Outputs Limited to 100 Files
        • Deprecation of 'fw import' Command (CLI)
        • Flywheel Core 19.1
        • Flywheel Core 19.0
        • Flywheel Core 18.5
        • Flywheel Core 18.4
        • Flywheel Core 18.3
        • Flywheel Core 18.2
        • Flywheel Core 18.1
        • Flywheel Core 18.0
        • Flywheel Core 17.x
        • Flywheel Core 16.x
        • Flywheel Core 15.x
        • Flywheel Core 14.x
        • Flywheel Core 13.x
    • Forum
    • Support
      • Find your Flywheel Version
      • Viewing Your Support Tickets
        • Authentication Troubleshooting: User Unable to Sign In
        • How to Request changes in JupyterLab compute options
        • How to Request Gear GPU Compute
        • How to Request Gear Compute Changes
        • Determine GPU Drivers
        • Unable to Create an Unsorted Project
        • Unable to Sign In

    Index

    Forum

    We're redirecting you our forums. If this doesn't happen automatically please click this link.

    Copyright © 2024 Flywheel. All Rights Reserved

    Cookie Consent

    This website uses cookies to improve your experience on this website and across the web. For more detail about the information we share about your use of our site with our advertising and analytics partners, see our Privacy Policy