Merge pull request #107 from vsoch/master

updating docs

doc/source/about.rst

@@ -1,7 +1,7 @@
 About
 =====
 
-The Experiment Factory is developed by the `Poldracklab <http://poldracklab.stanford.edu>`_ at Stanford University, and all code is publicly available on `Github <http://www.github.com/expfactory>`_. The current landscape of behavioral paradigms is messy at best, and so the Experiment Factory is an effort to standardize, organize, and collaboratively develop experiments that can be run on multiple infrastructures. Currently supported is generating experiments in a battery intended to run with `psiturk <https://github.com/NYUCCL/>`_ on a local computer, a vagrant virtual machine, or Amazon Web Services. We intend to add support for docker and other web applications soon, and welcome your contributions to `experiments <http://www.github.com/expfactory/expfactory-experiments>`_, `psiturk battery generation <http://www.github.com/expfactory/expfactory-battery>`_, `virtual machines <http://www.github.com/expfactory/expfactory-vm>`_, and the `software itself <http://www.github.com/expfactory/expfactory-python>`_.
+The Experiment Factory is developed by the `Poldracklab <http://poldracklab.stanford.edu>`_ at Stanford University, and all code is publicly available on `Github <http://www.github.com/expfactory>`_. The current landscape of behavioral paradigms is messy at best, and so the Experiment Factory is an effort to standardize, organize, and collaboratively develop experiments that can be run on multiple infrastructures. Currently supported is generating experiments in a battery intended to run with `psiturk <https://github.com/NYUCCL/>`_ on a local computer, a vagrant virtual machine, or Amazon Web Services. We intend to add support for docker and other web applications soon, and welcome your contributions to `experiments <http://www.github.com/expfactory/expfactory-experiments>`_, `surveys <http://www.github.com/expfactory/expfactory-surveys>`_,  and `games <http://www.github.com/expfactory/expfactory-experiments>`_, along with the infrastructure for `psiturk battery generation <http://www.github.com/expfactory/expfactory-battery>`_, `virtual machines <http://www.github.com/expfactory/expfactory-vm>`_, and the `software itself <http://www.github.com/expfactory/expfactory-python>`_.
 
 We are called the Experiment Factory because we want the software to support flexibility in designing the experiments, infrastructure, and deployment for your experiments.  Psychology and neuroscience researchers should have the same modern tools available to them as a commercial effort, and long gone should be the days of passing around paradigms from computer to computer on USB sticks. If we work together we can refine experiments to make them better, and making behavioral measurments with the same thing is one step toward a vision of reproducible science.
 
@@ -13,6 +13,15 @@ Psiturk
 '''''''
 These experiments are intended to run via the `psiturk infrastructure<https://github.com/NYUCCL/psiTurk>_`, and the `experiment factory battery<http://www.github.com/expfactory/expfactory-battery>_` is the main experiment code that, when fit with `experiments<http://www.github.com/expfactory/expfactory-experiments>_`, can run on Amazon Mechanical Turk.
 
+Phaser
+''''''
+We are collaborating with the `Stanford Cognitive and Systems Neuroscience Lab <http://scsnl.stanford.edu/>`_ to make simple, fun HTML event driven games that are integrated into the Experiment Factory frameowrk. This work is in its infancy, and it's going to be fun to see where we take it!
+
+
+Material Design Lite
+''''''''''''''''''''
+We use `Google Material Design Lite <http://getmdl.io>`_ as our template for forms, as it offers a beautiful user experience, and have implemented a basic validation for it and pagination using JQuery Wizard.
+
 
 JsPsych
 '''''''

doc/source/api.rst

@@ -1,8 +1,29 @@
 Application Program Interface (API)
 ===================================
 
-About the API
--------------
+Expfactory.org API
+------------------
+
+For experiments served with expfactory.org, we offer an `interactive RESTful API <http://www.expfactory.org/api/results>`_, and a python module `expanalysis <http://www.github.com/expfactory/expfactory-analysis>`_ specifically for retrieving and working with results. To use the API, you will need to provide a token generated when you log in to expfactory.org. First install the analysis package:
+
+::
+
+      pip install expanalysis
+
+
+Then when you have your token, here is how to use it from python:
+
+::
+
+      from expanalysis.api import get_results
+
+      access_token = "abcdefghijklmnopqrstuvwxyz" # expfactory.org/token
+      results = get_results(access_token=access_token) 
+
+
+
+Experiments API
+---------------
 
 The experiment factory executable is useful for making new batteries and experiments, but it can also work to serve a `RESTful API <https://en.wikipedia.org/wiki/Representational_state_transfer>`_. This basically means you can type in URLs in your browser, and it will spit data back at you. The data is in the JavaScript Object Notation (JSON) format, which is super easy to read into your software of choice (python, R, matlab, etc.). If you want to download static versions of the experiment data, we also `provide those <https://github.com/expfactory/expfactory.github.io/tree/master/data>`_ in our Github repo. We recommend, however, that you use the API because it will always download and return the most up-to-date experiments.