mesonic#

pre-commit black github-actions

a Sonification Framework

Installation#

You can install mesonic with the default backend sc3nb using pip

pip install mesonic[sc3nb]

Note that to run the notebooks mesonic also requires a backend like SuperCollider and/or pya to be installed.

Developer Installation#

To clone and install mesonic with dependencies required for the notebooks run:

git clone https://github.com/interactive-sonification/mesonic.git
cd mesonic
pip install -e ".[notebooks]"

Running Tests & Building#

We use tox for the automation of tasks like testing and building.

Please refer to the tox.ini file for more details

Making Changes & Contributing#

This project uses pre-commit, please make sure to install it before making any changes:

pip install pre-commit
cd mesonic
pre-commit install

update the hooks to the latest version:

pre-commit autoupdate