Welcome to rtCloud’s documentation!

Contents:

• Overview
• Realtime fMRI Cloud Framework
• Quickstart Demo: sample project via Docker
• RTCloud Installation & Usage
  • 1. Install Docker, Singularity, or Miniconda
    • Docker Installation
    • Local Installation
  • 2. Making RTCloud secure with SSL encryption
    • 2a. Create SSL certificate and username/password
    • 2b. Copy your certs folder to all other machines
    • 2c. Install SSL certificate
  • 3. Prepare your experiment’s script
  • 4. Run RTCloud experiment: template project
    • 4a. Run data_analyser
    • 4b. Run data_streamer
    • 4c. Run analysis_listener
  • 5. Setting up adaptive stimulus presentation with analysis_listener
    • 5a. PsychoPy example for template project
  • 6. Run the template experiment
  • 7. Using RTCloud with your own project
• “Replaying” an OpenNeuro dataset
• Sharing your RT-Cloud pipeline as a Docker image
• Other Links
• Troubleshooting / Common errors
  • Running the Automated Test Suite
• Running a Realtime Experiment
  • Running the ProjectInterface
    • Running ProjectInterface in the Cloud
    • Running ProjectInterface Locally
  • Connecting with the Browser
    • SSL Certificate Installation
      • Install the SSL Certificate in your Web Browser
    • Open Web Page in Browser
    • Notes on Security
  • Using VNC Server to view an application’s display on the server
    • Install VNC Server on the projectServer Computer
  • Definitions
• Making your project cloud enabled
  • Project Code
    • Initialization code
    • Retrieving DICOM Images from the Scanner Computer
    • Send Classification Results for Subject Feedback
    • Update the User’s Webpage Display
    • Read Files from the Console Computer (such as configuration files)
    • Load Project Configurations
    • Timeout Settings
      • Setting Global Timeouts:
      • Setting Per-Call Timeouts:
  • Some Alternate Configurations For Your Experiment
    • Running everything on the same computer
    • Running the subjectService remotely, but read DICOM data from the disk of the projectInterface computer
    • Reading both remote and local data
• Providing Feedback to Subjects
  • Using jsPsych
    • Running the Demo
      
• Using the BIDS Data Standard with RT-Cloud
  • BIDS Introduction
    • The BIDS Archive
    • BIDS Apps
  • Why Use BIDS with RT-Cloud
    • BIDS Apps
    • Benefits of BIDS Data Standardization
  • Adapting BIDS for use in Real-Time fMRI Experiments
  • How to Incorporate BIDS into your RT-Cloud project
  • Replaying Data from OpenNeuro
• Run Project in a Docker Container
  • Allocate a VM in the cloud
    • Some notes for Azure VM:
  • Install Docker
  • Install rtcloud for Docker
  • Run rtcloud projectInterface
  • Alternate simpler calls using the run-docker.sh script
  • Alternate methods using docker-compose
  • Docker Image with ANTs, FSL and C3D (brainiak/rtcloudxl)
  • Building Docker Images
• VM
• MRI control
• presenter
• psychopy
• API Reference
  • rtCommon
    • Submodules
      • rtCommon.addLogin
      • rtCommon.bidsArchive
      • rtCommon.bidsCommon
      • rtCommon.bidsIncremental
      • rtCommon.bidsInterface
      • rtCommon.bidsRun
      • rtCommon.certsUtils
      • rtCommon.checkDicomNiftiConversion
      • rtCommon.clientInterface
      • rtCommon.dataInterface
      • rtCommon.dicomToBidsService
      • rtCommon.errors
      • rtCommon.exampleInterface
      • rtCommon.exampleService
      • rtCommon.fileWatcher
      • rtCommon.imageHandling
      • rtCommon.openNeuro
      • rtCommon.openNeuroService
      • rtCommon.projectServer
      • rtCommon.projectServerRPC
      • rtCommon.projectUtils
      • rtCommon.remoteable
      • rtCommon.resample
      • rtCommon.scannerDataService
      • rtCommon.serialization
      • rtCommon.structDict
      • rtCommon.subjectInterface
      • rtCommon.subjectService
      • rtCommon.utils
      • rtCommon.validationUtils
      • rtCommon.webDisplayInterface
      • rtCommon.webHttpHandlers
      • rtCommon.webServer
      • rtCommon.webSocketHandlers
      • rtCommon.wsRemoteService

Indices and tables

• Index

• Module Index

• Search Page