Metadata-Version: 2.1
Name: smacc
Version: 0.0.1
Summary: Sleep manipulation and communication clickything
Home-page: https://github.com/remrama/smacc
Author: Remington Mallett
Author-email: mallett.remy@gmail.com
Project-URL: Homepage, https://github.com/remrama/smacc
Project-URL: Source, https://github.com/remrama/smacc
Project-URL: Bug Tracker, https://github.com/remrama/smacc/issues
Project-URL: Release Notes, https://github.com/remrama/smacc/releases
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# Sleep Manipulation And Communication Clickything

A clickable interface for running sleep-related experiments.

* Trigger audio cues
* Collect dream reports
* Trigger EEG portcods
* Save a detailed event log
* and more!


## Installation

```bash
# Install SMACC
pip install smacc

# Use SMACC to generate some wav files for cueing.
python -m smacc.generate_cues
python -m smacc.generate_noise  # noise to mask the cues

# If planning to use parallel port, download InpOut32
python -m smacc.download_inpout
```


## Usage

### Before opening SMACC

* Place any sound files in the `stimuli` folder (**must be .wav files!**).
* Optional: Insert dream report questionnaire link in `config.json`.


### Open SMACC

```bash
python -m smacc.run
```

### Check recording device.

* From the Menu bar, choose sound device for playing audio (`Audio > Input device > [choose device]`)
* From the Menu bar, choose sound device for recording dreams (`Audio > Output device > [choose device]`)

