Welcome to alfred3 #

alfred3 - a library for rapid experiment development

Alfred3 is a package for Python 3 offering experimenters in the social sciences a fast and easy way to create truly dynamic computer experiments for a wide range of applications.

Installation#

If you are starting from scratch, please go to our detailed installation video: https://youtu.be/of_3RDjCijI

But if you already have Python 3.7 or newer installed, just install alfred3 via pip:

$ pip3 install alfred3

Note

The above is a terminal command. You can type or paste this command into your ´*terminal* app (Mac) or the command line prompt (Windows) to install alfred3. The $ at the start indicates the start of a new command. If you copy-paste the command, you can omit the $.

A “Hello, world” experiment#

Creating a hello-world experiment is as easy as writing this script.py file. You can even do it in a simple text editor. Note that the file must be named script.py:

import alfred3 as al
exp = al.Experiment()
exp += al.Page("Hello, world!", name="hello_world")

To run the script, open a terminal and change the working directory to your experiment directory:

$ cd path/to/experiment

Next, simply execute the following command in the terminal:

$ alfred3 run

If you have Google Chrome installed on your machine, a browser window with the experiment opens automatically. Otherwise, open any webbrowser and visit http://127.0.0.1:5000/start to start the experiment.

Of course, this “Hello, world” experiment does not contain much content: Only a single page with a heading. You can learn how to add content to an experiment in our tutorials, listed in the left sidebar under “how to”.

If you have never programmed in python before, you are welcome to visit our python introduction course: https://ctreffe.github.io/alspace/py3-tutorial

Questions and Answers#

We use GitHub discussions: ctreffe/alfred#q-a You can ask questions, share ideas, and showcase your work there. Do not hesitate to ask!

Citation#

Important

If you are publishing research conducted using alfred3, the following citation is required:

Treffenstaedt, C., Brachem, J., & Wiemann, P. (2021). Alfred3 - A library for rapid experiment development (Version x.x.x). Göttingen, Germany: https://doi.org/10.5281/zenodo.1437219

If you want to use alfred3, please contact us via alfred@psych.uni-goettingen.de.

alfred3 Mailing List#

If you want to stay up to date with current developments, you can join our mailing list. We use this list to announce new releases and spread important information concerning the use of Alfred. You can expect to receive at most one mail per month.

Documentation content#

How To

API Reference Overview#

This is an overview of the modules, for which documentation is available.

`experiment`	This module contains the main experiment and experiment session objects.
`randomizer`	Module for randomizing functionality.
`SessionQuota`	A quota for experiment sessions.
`section`	Sections organize movement between pages in an experiment.
`page`	Pages hold and organize elements.
`element`	Provides element classes for adding content to pages.
`cli`	Command line interface for alfred3.
`util`	Provides miscellaneous utilities for alfred experiments.
`admin`	Functionality associated with alfred3's admin mode.

Welcome to alfred3

Contents