Skip to content

Welcome to the new and improved Flywheel Documentation Portal! Please let us know how we're doing. Provide Feedback.

Flywheel Documentation

Forum Redirect

Initializing search

Home
User Guides
Clinical
Data Transfer
CLI
Developer
Administration
Release Notes
Forum
Support
Index

Flywheel Documentation

Home
User Guides
User Guides
- Sign In
  Sign In
  - How to Replace Legacy API Keys
  - Using University Credentials to Sign In
- Navigate
  Navigate
- Organize
  Organize
- Upload
  Upload
- Forms
  Forms
  - Creating Custom Forms with Form Builder
  - Installation of Form Builder and Viewer
- Search
  Search
- View
  View
  - BrainBrowser Info
  - Introduction to Read Tasks
  - Montage Info
  - General
    General
    
    Data requirements
    
    Supported SOP Class UID Values
  - V2
    V2
    
    Viewer Indexing Errors
    
    OHIF Config File
    
    View and Annotate Images
  - V3
    V3
    
    Getting started with the V3 viewer
    
    Annotate Images
    
    3D segmentations
    
    TMTV Mode
    
    Configuring the viewer
- Reporting
  Reporting
  - Study Participant Project Report
  - Data views
    Data views
    
    Data Views
    
    Data Views Available Fields and Technical Specifications
- Enhancing
  Enhancing
- Compute
  Compute
  - Gears
    
    Gears
    
    Analysis Tab
    
    Analysis Gears
    
    Building a MATLAB Gear
    
    Dcm2niix Troubleshooting
    
    Gear Exchange
    
    Gear Rule Processing Details
    
    Gear Rules
    
    Types of Gears
    
    Gear Type and Gear Access
    
    Introduction to a SDK Gear
    
    Obtaining an Error File when Debugging fMRIPrep Failures
    
    Prioritizing Jobs and Gear Execution
    
    Running a Flywheel Job Locally with Docker
    
    Running an Analysis Gear on a Subject
    
    Running Gears as a Batch
    
    Tag Management
    
    Using the Jobs Log, Views, Tabs and Actions
    
    Utility Gears
    
    Best practices
    Best practices
    
    Preparing Acquisitions for Automated Classification
    
    Automated Quality Assurance: MRIQC Gear
    
    Best Practices: File Metadata Importer and File Classifier
    
    Gear Versioning
    
    Use Gear Rules to Automate Data Preprocessing
    
    Freesurfer
    Freesurfer
    
    Including a FreeSurfer License File to Run a FreeSurfer or fMRIPrep Gear
  - AI Development
    AI Development
    
    Flywheel Notebooks User Guide
- Download
  Download
- Delete
  Delete
  - Deleting Data
  - Deleting Flywheel Data
- Advanced Topics
  Advanced Topics
Clinical
Clinical
- Image Viewer
  Image Viewer
  - Annotating Data
  - Revert to the Legacy DICOM/NIfTI Viewer
- Reader Studies
  Reader Studies
  - Creating a Viewer Protocol
- Organization for Human Brain Mapping
  Organization for Human Brain Mapping
- Grant Resources
Data Transfer
Data Transfer
- Getting Data In
  Getting Data In
  - Ad hoc Upload
  - Bulk Import
    
    Bulk Import
    
    How to Import Data (Web App)
    
    How to Import Data (CLI)
    
    Monitoring
    
    Cancelling
    
    Troubleshooting
    
    Advanced Topics
    Advanced Topics
    
    Conflict Handling
    
    De-Identification
    
    Locating an Import Job ID
    
    Malware Scanning
    
    Mapping & Grouping (20.5+)
    
    Mapping Rules (19.4-20.4)
    
    Metadata
    
    Reference-in-Place
    
    Scheduling
  - DICOM Connector
    
    DICOM Connector
    
    User Guide
    
    Admin Guide
    
    Technical Reference
  - (Legacy) DICOM Upload
  - (Legacy) Bulk Ingest
    (Legacy) Bulk Ingest
    
    Detect Duplicate Files with Ingest (Legacy)
    
    Ingest Template - Parameters Reference
    
    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
  Getting Data Out
  - Bulk Export
    
    Bulk Export
    
    How to Export Data (Web App)
    
    How to Export Data (CLI)
    
    Monitoring
    
    Cancelling
    
    Troubleshooting
    
    Advanced
    Advanced
    
    Locating an Export Job ID
    
    Metadata
    
    Scheduling
    
    Settings
- Migrating Data
  Migrating Data
  - Migrating Project Data between Flywheel Sites
CLI
CLI
- Getting Started
  Getting Started
- Commands
  Commands
  - Authentication
    
    Authentication
  - Version Check
    
    Version Check
  - File Management
    
    File Management
  - Ingest Data
    
    Ingest Data
    
    Bids
    
    Bids
    
    Dicom
    
    Dicom
    
    Import DICOM Files (How-To)
    
    Folder
    
    Folder
    
    Import Structured Folder (How-To)
    
    Project
    
    Project
    
    Template
    
    Template
    
    Template Overview
    
    Template Reference Guide
    
    How To Create a Template
    
    Template Examples
    
    De-identify Data with Ingest
    
    Understanding Ingest Templates
    
    Advanced Usage
    Advanced Usage
    
    Audit Log
    
    Detect Duplicates
    
    Cluster Ingest
    
    AWS S3 Credentials
    
    Detecting Duplicate Files with fw ingest
    
    Troubleshooting
  - Export BIDS
    
    Export BIDS
  - Sync to Storage
    
    Sync to Storage
    
    Export Templates
  - De-identification
    
    De-identification
  - Command Cheat Sheet
  - Command Comparison
- Troubleshooting
  Troubleshooting
Developer
Developer
- SDK and API
  SDK and API
- Gear
  Gear
- UI Extension App
  UI Extension App
  - Applications Examples
- BIDS
  BIDS
- Toolkit
  Toolkit
- Webinar Series
  Webinar Series
Administration
Administration
- Access Control
  Access Control
- Authentication
  Authentication
- API Keys
  API Keys
  - Overview
  - Creating API Keys
- Data Backup
  Data Backup
- De-Identification
  De-Identification
- Devices
  Devices
- External Storages
  External Storages
- Extension Applications
  Extension Applications
- Gears & Compute
  Gears & Compute
- Project Configuration
  Project Configuration
- Reporting
  Reporting
  - Usage Report
Release Notes
Release Notes
- Announcements
  Announcements
- Release Notes
  Release Notes
  - Flywheel Core 21.1
  - Flywheel Core 21.0
  - Flywheel Core 20.6
  - Flywheel Core 20.5
  - Flywheel Core 20.4
  - Flywheel Core 20.3
  - Flywheel Core 20.2
  - Flywheel Core 20.1
  - Flywheel Core 20.0
  - Flywheel Core 19.5
  - Flywheel Core 19.4
  - Flywheel Core 19.3
  - Flywheel Core 19.2
  - Flywheel Core 19.1
  - Flywheel Core 19.0
  - Previous Versions
    Previous Versions
    
    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
Forum
Forum
Support
Support
Index

Forum Redirect

Forum

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

September 18, 2025 March 27, 2024

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

Google Analytics

Manage settings