SweetBean

SweetBean: A declarative language for behavioral experiments with human and artificial participants - Published in JOSS (2025)

https://github.com/autoresearch/sweetbean

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 9 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    1 of 3 committers (33.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

automated-documentation behavioral-experiments online-behavioral-experiments synthetic-participants
Last synced: 4 months ago · JSON representation ·

Repository

A declarative programming language built in Python, designed for the synthesis of behavioral experiments

Basic Info
Statistics
  • Stars: 2
  • Watchers: 1
  • Forks: 1
  • Open Issues: 7
  • Releases: 20
Topics
automated-documentation behavioral-experiments online-behavioral-experiments synthetic-participants
Created about 3 years ago · Last pushed 9 months ago
Metadata Files
Readme Contributing License Citation

README.md

PyPI GitHub Workflow Status PyPI - Downloads Link to docs License: MIT DOI

SweetBean

A declarative programming language built in Python, designed for the synthesis of behavioral experiments. It allows researchers to specify experiments once and seamlessly compile them into a jsPsych experiment for conducting studies with human participants or text-based simulations with synthetic participants using large-language models.

Features

  • Declarative language: Specify experiments once and compile them into a jsPsych experiment for conducting studies with human participants or text-based simulations with synthetic participants using large-language models.
  • Python-based: SweetBean is built in Python, making it accessible and easy to use for researchers and educators.

Integrate with other packages

This package seamlessly integrates with other packages aimed at running online behavioral experiments:

  • AutoRA: For closed loop research, automatic experiment deployment, participant recruitment, and data collection.
  • SweetPea: For experimental design.

But it can also be used as a standalone product.

Installation

The package is available on PyPI and can be installed via pip:

bash pip install sweetbean

Compatibility

SweetBean is compatible with the following version of jsPsych:

  • jsPsych: 7.x

Dependencies

Sweetbean has the following dependencies that need to be installed on your system:

  • Python: >=3.9, <4.0
  • java

Other versions may work but are not officially supported. If you experience issues, please report them!

Python Dependencies

The following Python packages are required and will be installed automatically via pip:

  • jinja2
  • transcrypt
  • pyppeteer
  • pillow

jsPsych Plugins

SweetBean does not support all jsPsych plugins, but new plugins are added regularly.
If you need support for a specific jsPsych plugin, please open an issue here.

Documentation

You can find examples and documentation here: https://autoresearch.github.io/sweetbean/

Issues

Please report any issues with this software or its documentation here.

Contributing

We are open to contributions to SweetBean. More information can be found here.

Collaborating

We are always interested in collaborating! If you like our work but need some tailoring for your specific use case, please contact ystrittmatter@princeton.edu.

Citation

If you would like to reference SweetBean in a publication, you can use the following BibTeX entry referencing the associated publication in the Journal of Open Source Software:

bibtex @article{Strittmatter2025, doi = {10.21105/joss.07703}, author = {Younes Strittmatter and Sebastian Musslick}, title = {SweetBean: A declarative language for behavioral experiments with human and artificial participants}, url = {https://doi.org/10.21105/joss.07703}, year = {2025}, publisher = {The Open Journal}, volume = {10}, number = {107}, pages = {7703}, journal = {Journal of Open Source Software}, doi = {10.21105/joss.07703} }

About

This project is in active development by the Autonomous Empirical Research Group, Lead Designer Younes Strittmatter, led by Sebastian Musslick.

This research program was supported by Schmidt Science Fellows, in partnership with the Rhodes Trust, as well as the Carney BRAINSTORM program at Brown University.

Owner

  • Name: Autonomous Empirical Research Initiative
  • Login: AutoResearch
  • Kind: organization

We strive to enhance and accelerate scientific discovery by automating steps in the empirical research process.

JOSS Publication

SweetBean: A declarative language for behavioral experiments with human and artificial participants
Published
March 20, 2025
Volume 10, Issue 107, Page 7703
Authors
Younes Strittmatter ORCID
Princeton University, USA, Brown University, USA
Sebastian Musslick ORCID
Osnabrück University, Germany, Brown University, USA
Editor
Stefan Appelhoff ORCID
Tags
online behavioral experiments large language model experiments declarative language synthetic participants

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Strittmatter
  given-names: Younes
  orcid: "https://orcid.org/0000-0002-3414-2838"
- family-names: Musslick
  given-names: Sebastian
  orcid: "https://orcid.org/0000-0002-8896-639X"
contact:
- family-names: Strittmatter
  given-names: Younes
  orcid: "https://orcid.org/0000-0002-3414-2838"
doi: 10.5281/zenodo.15054706
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Strittmatter
    given-names: Younes
    orcid: "https://orcid.org/0000-0002-3414-2838"
  - family-names: Musslick
    given-names: Sebastian
    orcid: "https://orcid.org/0000-0002-8896-639X"
  date-published: 2025-03-20
  doi: 10.21105/joss.07703
  issn: 2475-9066
  issue: 107
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 7703
  title: "SweetBean: A declarative language for behavioral experiments
    with human and artificial participants"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.07703"
  volume: 10
title: "SweetBean: A declarative language for behavioral experiments
  with human and artificial participants"

GitHub Events

Total
  • Create event: 70
  • Issues event: 70
  • Release event: 19
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 10
  • Push event: 320
  • Pull request review comment event: 2
  • Pull request review event: 3
  • Pull request event: 158
  • Fork event: 1
Last Year
  • Create event: 70
  • Issues event: 70
  • Release event: 19
  • Watch event: 1
  • Delete event: 2
  • Issue comment event: 10
  • Push event: 320
  • Pull request review comment event: 2
  • Pull request review event: 3
  • Pull request event: 158
  • Fork event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 261
  • Total Committers: 3
  • Avg Commits per committer: 87.0
  • Development Distribution Score (DDS): 0.153
Past Year
  • Commits: 200
  • Committers: 3
  • Avg Commits per committer: 66.667
  • Development Distribution Score (DDS): 0.2
Top Committers
Name Email Commits
Younes Strittmatter y****r@b****u 221
Sebastian Musslick s****n@m****e 39
Ankush1oo8 1****8 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 33
  • Total pull requests: 79
  • Average time to close issues: 5 days
  • Average time to close pull requests: about 4 hours
  • Total issue authors: 5
  • Total pull request authors: 3
  • Average comments per issue: 0.27
  • Average comments per pull request: 0.0
  • Merged pull requests: 77
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 33
  • Pull requests: 79
  • Average time to close issues: 5 days
  • Average time to close pull requests: about 4 hours
  • Issue authors: 5
  • Pull request authors: 3
  • Average comments per issue: 0.27
  • Average comments per pull request: 0.0
  • Merged pull requests: 77
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • younesStrittmatter (23)
  • musslick (13)
  • snamazova (2)
  • syntactic (1)
  • hauselin (1)
Pull Request Authors
  • younesStrittmatter (113)
  • musslick (18)
  • Ankush1oo8 (2)
Top Labels
Issue Labels
priority 1 - needed (8) documentation (6) bug (5) enhancement (3) good first issue (3) stimulus request (2) priority 3 - optional (2) priority 0 - emergency (1) priority 2 - wanted (1)
Pull Request Labels
documentation (16) priority 1 - needed (1) priority 2 - wanted (1) enhancement (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 655 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 60
  • Total maintainers: 1
pypi.org: sweetbean

A declarative language in python for creating jsPsych experiments

  • Documentation: https://sweetbean.readthedocs.io/
  • License: MIT License Copyright (c) 2022 Younes Strittmatter Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 1.3.3
    published 9 months ago
  • Versions: 60
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 655 Last month
Rankings
Dependent packages count: 10.1%
Average: 16.9%
Downloads: 18.9%
Dependent repos count: 21.6%
Maintainers (1)
Last synced: 4 months ago

Dependencies

.github/workflows/publish-documentation-gh-pages.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
sweetbean/requirements.txt pypi