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 on readthedoc.org: [http://psiturk.readthedocs.org/en/latest/](http://psiturk.readthedocs.org/en/latest/).

---

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](wiki/Foreword#understanding-the-psiturk-design-philosophy-an-analogy)
– [What is Mechanical Turk?](wiki/Foreword#what-is-mechanical-turk)
– [What is psiTurk?](wiki/Foreword#what-is-psiturk)
– [How do I host a psiTurk experiment?](wiki/Foreword#how-do-i-host-a-psiturk-experiment)
– [Do I have to learn to code?](wiki/Foreword#do-i-have-to-learn-to-code)
– What common issues arise?
- Getting psiTurk installed on your computer
– [Requirements](wiki/Getting-psiTurk-installed-on-your-computer#requirements)
– [Install steps](wiki/Getting-psiTurk-installed-on-your-computer#installation-steps)
– [System-specific notes](wiki/Getting-psiTurk-installed-on-your-computer#system-specific-notes)
– [Mac](wiki/Getting-psiTurk-installed-on-your-computer#mac-os-x)
– [Linux](wiki/Getting-psiTurk-installed-on-your-computer#linux)
– [Windows](wiki/Getting-psiTurk-installed-on-your-computer#windows)
– [Cloud (Experimental)](wiki/Getting-psiTurk-installed-on-your-computer#wiki-cloud)
- 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

API Reference
=====

- psiTurk API

• [Creating the psiTurk object](wiki/psiTurk-API#creating-the-psiturk-object)
• [psiturk.taskdata](wiki/psiTurk-API#psiturktaskdata)
• [psiturk.preloadPages](wiki/psiTurk-API#psiturkpreloadpagespagelist)
• [psiturk.getPage](wiki/psiTurk-API#psiturkgetpagepagename)
• [psiturk.showPage](wiki/psiTurk-API#psiturkshowpagepagename)
• [psiturk.preloadImages](wiki/psiTurk-API#psiturkpreloadimagesimagelist)
• [psiturk.recordTrialData](wiki/psiTurk-API#psiturkrecordtrialdataarray)
• [psiturk.recordUnstructuredData](wiki/psiTurk-API#psiturkrecordunstructureddatafield-value)
• [psiturk.saveData](wiki/psiTurk-API#psiturksavedatacallbacks)
• [psiturk.finishInstructions](wiki/psiTurk-API#psiturkfinishinstructions)
• [psiturk.teardownTask](wiki/psiTurk-API#psiturkteardowntask)
  - Routes
• /inexp
• etc…