Home

WARNING!!!!!! psiTurk is currently undergoing a major update that will break compatibility with past versions. Documentation is now being updated to refer to the project version in the /dev branch. Sorry for confusion, but things will settle down shortly. Documentation for the new version is being developed here on readthedocs.org.

---

Welcome to psiTurk's documentation. To start, you'll first need to install psiTurk. Instructions can be found on the Getting psiTurk installed on your computer page. Afterwards, head over to Quickstart, or for a more detailed tutorial demonstrating how to setup a simple experiment with psiTurk, visit Getting up and running with the basic Stroop task.

User's Guide

• Foreword
  • The psiTurk design philosophy: An analogy
  • What is Mechanical Turk?
  • What is psiTurk?
  • How do I host a psiTurk experiment?
  • Do I have to learn to code?
  • What common issues arise?
• Getting psiTurk installed on your computer
  • Requirements
  • Install steps
  • System-specific notes
    • Mac
    • Linux
    • Windows
    • Cloud (Experimental)
• Getting setup with Amazon Mechanical Turk
  • Obtaining AWS credentials
  • Creating a AMT Requester account
  • Linking funds
• Quickstart
• Step-by-step tutorials
  • Overview of the command line interface
  • Configuring databases
  • Getting up and running with the basic Stroop task
  • Decomposing the Stroop task
• Anatomy of a project
  • config.txt
  • participants.db
  • server.log
  • exp.html
  • task.css
  • psiturk.js
  • task.js
  • utils.js
• Recording and saving data
• Crediting participants
  • Via interactive shell
  • Via AMT site
  • How much should I pay?
• Basics and/or references on external libraries
  • JQuery
  • Underscore
  • Backbone
• FAQ
  • Host your own SSL certificate
  • Integrate psiTurk with a pre-existing server

API Reference

• psiTurk API
  • Creating the psiTurk object
  • psiturk.taskdata
  • psiturk.preloadPages
  • psiturk.getPage
  • psiturk.showPage
  • psiturk.preloadImages
  • psiturk.recordTrialData
  • psiturk.recordUnstructuredData
  • psiturk.saveData
  • psiturk.finishInstructions
  • psiturk.teardownTask
• Routes
  • /inexp
  • etc...