# SoniScope

This ZIP archive contains:
- README.md (this text)
- LensWidgetSonification.ipynb (demo notebook, incl. sonification configuration playground)
- sonivis_lens_widget-0.1.3.dev0-py2.py3-none-any.whl (installable python package)
- source.zip (source code of the python package)
- requirements.txt (all python dependencies necessary to run the demo; equivalent to following the steps below)
- day.csv (bike sharing data from UCI ML repository)
- bike_day_semantic.csv (bike sharing data from UCI ML repository, rescaled to use meaningful data)

## Setup Instructions

1. Create a fresh python environment:
```
python -m venv venv
pip install --upgrade pip
source venv/bin/activate
```

2. Install packages:
```
pip install jupyterlab sc3nb
pip install sonivis_lens_widget-0.1.3.dev0-py2.py3-none-any.whl
```
3. Download SuperCollider (version 3.12.2) from <https://supercollider.github.io/download> and install it.

4. Start Jupyter Lab:
```
jupyter lab
```

5. Open the notebook document `LensWidgetSonification.ipynb`.

6. Run all cells from top to "Ploting the user interface".

## License

The source code is available under the terms of the MIT License.
