Create a Flywheel project

Welcome to Flywheel! This quick start guide explains how to set up a project in Flywheel and add data, so you can get started doing awesome science instead of data management.

What's a project in Flywheel?
In Flywheel, a project is a way to organize data from an experiment or other collection of subject data. Usually where the protocol for the experiment stays relatively constant.
Our article on the Flywheel hierarchy  explains in more detail how data is organized on the platform.

Steps

  1. Sign in to Flywheel.
    Contact your site admin if you are having trouble signing in.
    Projects-Export-update.png

  2. From Projects, Click New Project.
    Create new project message appears

  3. Select one of your groups from the list.New_project.png

  4. Give your project a name.

    Tip: A project name needs to be unique to the group it's created in.

  5. Determine permissions for the project:

    • Enable Default Group Permissions: Applies the permissions for the group to this project. For example, users who have Read Only permissions to the group will also have Read Only permissions for this project

    • Disable Default Group Permissions: Creates the project with you as the Project Admin. No other users are added to the project.

  6. Click Create.
    A success message appears and your project appears in the list.

Configure your project

Now that you’ve created your first project, let’s set it up so you can actually start using it. 

  1. Click on the project name.
    The Description page appears.  

  2. Add a description here to remind yourself and your collaborators of the purpose of the project. Be sure to add any important project specific information here as well. 

  3. Next, let's make sure your collaborators all have access to your project.

    1. Click the Permissions tab.
      All users with permission to the project are listed

      PermissionsPage-Project.png

    2. Click on Type a User. Either select a user from the list or type in a user's name. You can only select one user at a time.

    3. Select a Permission level. Learn more about the Roles and Permissions in Flywheel.

Add data to your project

Add your existing data to start getting the most out of Flywheel. Below are the methods for adding data to Flywheel:

  • DICOM data uploader reads through directories of files and uses the DICOM header information to group them into the correct Acquisitions, Sessions, and Subjects in Flywheel

  • Non-DICOM data uploader can be used for any other data you want to add to Flywheel. For example, a Study Protocol, blank consent forms or other related documentation so that all researchers working on the Project can collaborate effectively.

  • The Flywheel command-line interface (CLI) to bulk upload data using your Terminal app.

  • Manually move the sessions to your project if your data is in another project.

  • If your site is using a Connector, you’ll want to use the Flywheel Path of this project in the Flywheel Sort String that is set up for your site. Contact your Site Admin for specifics on how to do this.
    Projectpath-highlight.png

    What's next?

    videoicon.png  Prefer to learn about Flywheel through a video? See our intro to Flywheel video for a complete walkthrough of important Flywheel  concepts and how to do the most common tasks. 

Related articles