Simple rating demo

For the full set of experiment files, see demos/pipelines/01-simple-rating in the GitHub repository.

"""
This is a simple experiment where participants rate sounds on a scale from 1 to 5.
"""
# pylint: disable=missing-class-docstring,missing-function-docstring

from pathlib import Path
import psynet.experiment
from psynet.asset import asset  # noqa
from psynet.bot import Bot
from psynet.modular_page import (
    AudioPrompt,
    ModularPage,
    RatingScale,
    MultiRatingControl,
)
from psynet.page import InfoPage
from psynet.timeline import Event, Timeline
from psynet.trial.static import StaticNode, StaticTrial, StaticTrialMaker


STIMULUS_DIR = Path("data/instrument_sounds")
STIMULUS_PATTERN = "*.mp3"


def get_timeline():
    return Timeline(
        InfoPage(
            """
            In this experiment you will hear some sounds.
            Your task will be to rate them from 1 to 5 on several scales.
            """,
            time_estimate=5,
        ),
        StaticTrialMaker(
            id_="ratings",
            trial_class=CustomTrial,
            nodes=get_nodes,
            expected_trials_per_participant="n_nodes",
        ),
        InfoPage(
            "Thank you for your participation!",
            time_estimate=5,
        ),
    )

class CustomTrial(StaticTrial):
    time_estimate = 10

    def show_trial(self, experiment, participant):
        return ModularPage(
            "ratings",
            AudioPrompt(
                self.assets["stimulus_audio"],
                "Please rate the sound. You can replay it as many times as you like.",
                controls="Play",
            ),
            MultiRatingControl(
                RatingScale(
                    name="brightness",
                    values=5,
                    title="Brightness",
                    min_description="Dark",
                    max_description="Bright",
                ),
                RatingScale(
                    name="roughness",
                    values=5,
                    title="Roughness",
                    min_description="Smooth",
                    max_description="Rough",
                ),
            ),
            events={
                "submitEnable": Event(is_triggered_by="promptEnd"),
            },
        )

def get_nodes():
    return [
        StaticNode(
            definition={
                "stimulus_name": path.stem
            },
            assets={
                "stimulus_audio": asset(path, cache=True),  # reuse the uploaded file between deployments
            },
        )
        for path in STIMULUS_DIR.glob(STIMULUS_PATTERN)
    ]


class Exp(psynet.experiment.Experiment):
    timeline = get_timeline()

    def test_check_bot(self, bot: Bot, **kwargs):
        super().test_check_bot(bot, **kwargs)
        assert len(bot.alive_trials) == 6  # one for each instrument