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
• Version Control
• Provenance
• Gears

Beyond the Basics

• 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

• Working With Your Data Outside Flywheel

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
  • Download Data From Flywheel to Local Scratch (Part 1, Analyses)
  • Upload Results to Flywheel Analysis (Part 1, Session Analyses)
  • Upload Results to Flywheel Analysis (Part 2, Project Analyses)
  • Some Examples Looping Through All Sessions
    • Thats all Folks!
• Download and Run Analysis Locally
  • Requirements
    • CURC Jupyterhub
  • Setup
  • Flywheel API Key and Client
  • Constants
  • Helper functions
  • Main script
  • Download Analyses to Local Filesystem
• Upload My Analysis to Flywheel
  • Requirements
    • CURC Jupyterhub
  • Setup
  • Flywheel API Key and Client
  • Constants
  • Helper functions
  • Upload My Analysis