INC FLywheel has its documentation hosted on Read the Docs.

Welcome to INC Flywheel documentation!

Check out the Overview section for introductory information.

Note

This project is under active development.

Contents

Getting Started

• Overview
• At the Scanner
• Navigating The User Interface
• How To Cite Us

Basics

• User Permissions
• Hierarchy
• Viewing Data
• Metadata & Dataviews
• Version Control
• Provenance
• Gears

Beyond the Basics

• Starting A New Study?
• CLI Basics
• SDK Basics
• Deidentification
• Running Commonly Used Gears
• Uploading Event Files

Access to Petalibrary and Blanca

• The Basics
• High Performance Compute Portal
• Setting Up Conda Environments
• Get to Know Your Scratch Space

Developer's Guide

• NDA Data Submissions
• Automated Analysis Workflow

Resources

• Resources
• FAQs

Tutorials

• Flyhweel Software Developer Kit (SDK) Basics and Helpful Hints
  • Import Python Dependencies
  • Define Supporting Functions
  • Flywheel API Key and Client
  • Viewing a Flywheel Project
  • Viewing a Flywheel Analysis
  • Update Metadata In Flywheel
    • Thats all Folks!