# oTree experiments

Implementation of Implicit Associative Test for oTree v5

Features:
- customizable categories and stimuli
- using either words or images, or mix of them
- specifying stimuli in code or loading from csv file
- calculating d-score (in pure python) 
- some server-side anti-cheating and anti-script-kiddies protection

Configurable parameters (in session config):
- `primary: [left_primary, right_primary]` -- primary (top, concepts) categories,   
- `secondary: [left_secondary, right_secondary]` -- primary (top, concepts) categories
- `primary_images=True` or `secondary_images=True` -- use values as references to images instead of words  
- `num_iterations={1: int, 2: int, 3: int, 4: int, 5: int, 6: int, 7: int}` -- number of iterations for each round

See **Customization** below for details

Anti-cheating parameters:
- `trial_delay`: minimal delay between iterations
- `retry_delay`: minimal delay before next retry after wrong answer 

## Development with command-line

0. download/unzip content of this repo into some working directory, or clone it using git 
   ```bash
   git clone https://github.com/qwiglydee/otree-experiments/
   cd otree-experiments
   ```
1. create and activate virtualenv in working directory
   ```bash
   python -m venv .venv
   source .venv.bin/activate
   pip install --upgrade pip
   ```
2. install requirements
   ```bash
   pip install -r requirements.txt
   pip install -r requirements.devel.txt
   ```
3. run the development server
   ```bash
   otree devserver
   ```
4. open browser at `http://localhost:8000/`

## Development with PyCharm

0. download/unzip content of this repo into some working directory, or clone it using git 
1. Start Pycharm and open project from the working directory
2. Create virtual environment
   - Open Settings / Project: otree-experiments / Python interpreter
   - Open "⚙" / "Add..."
   - Select "Virtual environment"
   - Select "New environment"
   - Set Location := WORKINGDIR/.venv  or somewhere else
3. Install requirements
   - Open internal terminal from the very bottom
   - Make sure it displays "venv" in prompt
   - ```bash
      pip install -r requirements.txt
      pip install -r requirements.devel.txt
     ```
5. Setup Debugger:
   - Menu / Run / Edit Configurations / Add new
   - Select "Python"
   - Set Working directory
   - Set Script path := .venv/bin/otree  or a full path to venv otree
   - Parameters := devserver_inner
6. To run and debug devserver with Shift-F10 or Shift-F9
   - autoreloading on files changes won't work, press Ctrl-5 to reload manually
   - breakpoints will work, including code of `live_method`

## Customization

### Creating custom stimuli

Edit file `stimuli.py` and modify variable `DICT` to add categories and words, similar to what already exists.
The categories in dictionary are unpaired. You specify pairs in session config.

Category names can have prefixes like `english:family`, `spanish:familia`, `words:positive`, `emojis:positive`. 
The prefixes are stripped when displayed on pages in instructions or results.

### Loading stimuli from csv file

Put file `stimuli.csv` into the app directory. 
The file should contain first row for headers and at least 2 columns: `category`, `stimulus`.

Content of the file will be loaded into `DICT` at server startup/reload. 

### Using images

Put all you images into folder `static/images` within the app directory.

List filenames of the images in dictionary or csv file, just like words.

In initial setup images are expected to be about 240px height. 
Make sure your images are not too huge and wont consume too much traffic. 

### Adjusting styles and appearence

All the appearence is defined in file `static/iat.css`. 
Edit the file to change colors or sizes of category labels or stimuli.

Stimulus is marked as `.stimulus`, category labels in corners as `.category`.  

To style primary and secondary differently, change blocks referencing `.primary` and `.secondary`.

### Changing rounds' setup

Layouts for each round are given in file `blocks.py` variable `BLOCKS`,
which is set to `= BLOCKS1` initially.

There are two predefined setups: `BLOCKS1` and `BLOCKS2`. 
The first one is for classic setup, when primary category switches in last 3 rounds, and secondary remains in place.  
The second one is for alternative setup, when primary category stays, and secondary switches.