bride-of-frankensystem

KO | EN

gitlite — search

#python #ai #llm #android #linux #macos #java #nodejs #windows #cli #kubernetes #pytorch #security #mcp

bride-of-frankensystem

(★ 15)

An extension to the Flask web framework that facilitates the creation of online behavioral experiments and surveys. Define studies as plain-text TOML and JSON; embed Unity WebGL, jsPsych, and lab.js tasks. BOFS handles participant routing, condition assignment, sessions, data export, and more.

bride-of-frankensystem Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Bride of Frankensystem
======================

Bride of Frankensystem (BOFS) is an open-source framework for building online behavioral experiments and surveys.
You describe your study in plain-text files: a TOML config for settings and page flow, JSON files for questionnaires, 
and HTML files for custom pages. BOFS handles participant routing, condition assignment, consent forms, data storage, 
and provides an admin panel for monitoring and export.

Use BOFS when you need to go beyond the capabilities of online survey platforms like Qualtrics or SurveyMonkey. For example,
embedding custom tasks, assigning participants to different conditions, adding custom logic, etc. BOFS was originally built with 
the goal of making it easy to embed Unity WebGL games within a sequence of questionnaires, but supports hosting any kind 
of JavaScript task (e.g., jsPsych, lab.js, PsychoPy, P5.js, and more) or custom HTML.

BOFS is built on [Flask](https://flask.palletsprojects.com/). When the patterns built into BOFS aren't enough, custom 
Flask routes can be added to the same project.

BOFS is installed as a Python package and is managed separately from your own projects. New releases of BOFS are 
generally backwards compatible with experiments implemented using older releases - projects created in the first version
of BOFS (from 2015) work on the latest with only minor changes.

Citation
--------

If you use BOFS in your research, please cite it via the following identifiers:

- **DOI:** [10.5281/zenodo.11176739](https://doi.org/10.5281/zenodo.11176739) &nbsp;[![DOI](https://zenodo.org/badge/220541237.svg)](https://zenodo.org/badge/latestdoi/220541237)
- **RRID:** [SCR_028428](https://scicrunch.org/resolver/RRID:SCR_028428)

A BibTeX entry and full citation details are available on the [documentation site](https://bride-of-frankensystem.readthedocs.io/en/latest/#citation).

To see papers that have used BOFS to enable online data collection, see the [publications list](https://frankensystem.net/publications.html).

Documentation & Examples
------------------------

* [Documentation](https://bride-of-frankensystem.readthedocs.io/en/latest/)
* [Example Projects](https://github.com/colbyj/bride-of-frankensystem-examples)
* [Migrating to BOF 2.0](https://github.com/colbyj/bride-of-frankensystem/wiki/Migrating-to-BOFS-2.0)

Features
--------

* Built-in consent page. Edit the wording in an HTML file at the project root.
* Random assignment to conditions, with balancing as participants enroll.
* Experiment flow defined as a list of pages in your config file.
* Questionnaires defined in JSON: item-order shuffling, conditional questions and pages, and computed scores at
  submission time.
* Reuse earlier answers - for instance, embed a participant's prior rating into the wording of a later question.
* Repeated measurements, either within a session (pre/post) or across days and weeks via an external ID that resumes
  the participant's condition.
* Custom JSON-defined database tables for trial-by-trial events, task scores, mouse movement, or anything else your
  study generates. JavaScript POSTs to `/table/<name>`; rows show up in the admin panel.
* Static file serving for stimuli (images, audio, video), PDFs, and any JS libraries your custom pages need.
* MTurk and Prolific external-ID handling, with configurable completion-code redirects.
* Custom Python/Flask routes for embedded tasks or other server-side logic.
* Instruction and simple pages built from HTML alone, no Python required.
* Admin panel with live participant progress, per-condition descriptive statistics (N, mean, SD, median, box plots),
  and data export.

Installing and Running BOFS
===========================

Refer to the [installation instructions](https://docs.frankensystem.net/en/latest/getting_started/installation.html) in
the documentation.

Once installed, run `BOFS init` to generate a new project.

Dependencies
------------

BOFS requires Python 3.9+, along with the following Python packages:

* `flask` - the web framework BOFS is built on.
* `flask-wtf` - form handling and CSRF.
* `flask-sqlalchemy` - bridge between Flask and SQLAlchemy.
* `sqlalchemy` - ORM used for database table definitions and queries.
* `flask-compress` - supports the compressed assets that Unity WebGL builds use.
* `waitress` - production WSGI server; an alternative to Flask's built-in server or Apache.
* `toml` - configuration files use the TOML format.
* `crawlerdetect` - filters out web crawlers so they aren't counted as participants.
* `pandas` - data export and the admin results preview.
* `questionary` - interactive prompts in the `BOFS init` wizard.
* `bleach` - HTML sanitization for user-supplied content.
* `docstring-parser` - parses question-type schemas from template docstrings.

bride-of-frankensystem

bride-of-frankensystem Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

bride-of-frankensystem

bride-of-frankensystem Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README