diff --git a/docs/experiment-runner/behavioral/example.md b/docs/experiment-runner/behavioral/example.md new file mode 100644 index 000000000..9fa0adf83 --- /dev/null +++ b/docs/experiment-runner/behavioral/example.md @@ -0,0 +1,3 @@ +# Example: Closed-Loop Behavioral Study + +For a detailed example of setting up a closed-loop behavioral study with an online experiment, see the [Basic Closed-Loop Psychophysics Study](../../examples/closed-loop-basic/index.md). diff --git a/docs/online-experiments/firebase.md b/docs/experiment-runner/behavioral/firebase.md similarity index 100% rename from docs/online-experiments/firebase.md rename to docs/experiment-runner/behavioral/firebase.md diff --git a/docs/experiment-runner/behavioral/index.md b/docs/experiment-runner/behavioral/index.md new file mode 100644 index 000000000..3c230ea9b --- /dev/null +++ b/docs/experiment-runner/behavioral/index.md @@ -0,0 +1,8 @@ +# Online Experiments To Collect AutoRA Observations + +AutoRA provides functionality for running closed-loop behavioral studies with online experiments. This functionality allows researchers to set up websites that integrate with AutoRA workflows. These websites allow observations gathered from participants online. + +![System Overview](../../examples//img/system_overview.png) + +To enable this functionality, AutoRA can interface with databases, such as Firebase for hosting the website and storing data. In addition, AutoRA can recruit participants through platforms like Prolific. + diff --git a/docs/online-experiments/index.md b/docs/online-experiments/index.md deleted file mode 100644 index 4ab5d9ef9..000000000 --- a/docs/online-experiments/index.md +++ /dev/null @@ -1,4 +0,0 @@ -# Online Experiments To Collect AutoRA Observations - -AutoRA provides functionality to set up websites that integrate with AutoRA workflows. These websites allow observations gathered from participants online to be used in a closed-loop system. - diff --git a/mkdocs.yml b/mkdocs.yml index c98b0055e..ec99cb947 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -257,18 +257,18 @@ nav: - 'synthetic/docs/Examples/Psychology/Q-Learning.ipynb' - Psychophysics: - 'synthetic/docs/Examples/Psychophysics/Weber-Fechner-Law.ipynb' - - Firebase-Prolific: '!import https://github.com/autoresearch/autora-experiment-runner-firebase-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]' - - Firebase: '!import https://github.com/autoresearch/autora-experiment-runner-experimentation-manager-firebase/?branch=main&extra_imports=["mkdocs/base.yml"]' - - Prolific: '!import https://github.com/autoresearch/autora-experiment-runner-recruitment-manager-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]' + - Behavioral Web Experiments: + - Home: 'experiment-runner/behavioral/index.md' + - Example: 'experiment-runner/behavioral/example.md' + - Using Firebase: 'experiment-runner/behavioral/firebase.md' + - Firebase-Prolific Runner: '!import https://github.com/autoresearch/autora-experiment-runner-firebase-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]' + - Firebase Experimentation Manager: '!import https://github.com/autoresearch/autora-experiment-runner-experimentation-manager-firebase/?branch=main&extra_imports=["mkdocs/base.yml"]' + - Prolific Recruitment Manager: '!import https://github.com/autoresearch/autora-experiment-runner-recruitment-manager-prolific/?branch=main&extra_imports=["mkdocs/base.yml"]' - "Command Line Interface": - "Home": "core/docs/cli/index.md" - "Basic Usage": "core/docs/cli/basic-usage/README.md" - "Using Cylc": "core/docs/cli/cylc-pip/README.md" - "Using Cylc and Slurm": "core/docs/cli/cylc-slurm-pip/README.md" - - Online Experiments: - - Home: 'online-experiments/index.md' - - Firebase: 'online-experiments/firebase.md' - - Example: 'user-cookiecutter/docs/index.md' - Contributor Guide: - Home: 'contribute/index.md' - Modules: