index.rst

psiTurk Documentation

Website:	https://psiturk.org
Source code:	https://github.com/NYUCCL/psiturk
Issue tracker:	https://github.com/NYUCCL/psiturk/issues
Usage questions:	https://groups.google.com/forum/#!forum/psiturk
Twitter:	https://twitter.com/psiturk

Note

This is documentation for psiturk v3. Documentation for psiturk v2 can be found here.

Welcome to psiTurk's documentation. To learn more about the project, please visit https://psiturk.org.

To actually use psiTurk, you'll first need to install it on your local computer or server. Instructions can be found on the :ref:`install` page. Afterwards, head over to our :ref:`quickstart`.

For a more detailed tutorial demonstrating how to setup a simple experiment with psiTurk, visit :ref:`example-project-stroop`. Also, check out the :ref:`experiment-exchange` for examples to learn from, including demonstrations of integration with jspsych.

Migrating from psiturk 2 to psiturk 3? See the :ref:`migrating` guide.

Contents

• User's Guide
• Contributing to psiTurk
• API Reference
• Citing
• License

User's Guide

.. toctree::
   :maxdepth: 2

   forward
   quickstart
   migrating
   install
   amt_setup
   configuration-overview
   settings
   command_line_overview
   command_line
   databases_overview
   tutorials
   anatomy_of_project
   recording
   retrieving
   customizing
   dashboard
   experiment-exchange
   faq
   getting_help
   disclaimer

Contributing to psiTurk

.. toctree::
   :maxdepth: 2

   contribute
   roadmap

API Reference

.. toctree::
   :maxdepth: 2

   api

Citing

See the github repo README for how to cite usage of psiTurk.

License

See the LICENSEFILE on github.