Core Concepts

These pages cover the foundational concepts you need to work effectively with the Flywheel Python SDK.

Data Model

• Flywheel Data Hierarchy — An introduction to Flywheel's hierarchical structure of Groups, Projects, Subjects, Sessions, Acquisitions, and Analyses.

• Containers — CRUD Operations — How to create, read, update, and delete containers using the SDK.

• Metadata: Info, Tags, and Notes — How to leverage the three metadata types available on most containers: arbitrary JSON dicts (info), string labels (tags), and timestamped text entries (notes).

Querying and Collecting Data

• Finders — How to use finders to filter, sort, and iterate over results.

• Data Views — Structured queries that collect fields from across the hierarchy and return tabular data.

Files and Container Operations

• File Upload and Download — Methods for uploading and downloading files to and from Flywheel containers.

• Smart Copying Containers — How to create copies of containers throughout the Flywheel hierarchy.

Client Configuration

• Client Configuration - Information on flywheel.Client defaults and configuration options, including timeouts, retries, and debug mode.