Planning for a Python package MVP

[sewardlee337]

It would be really cool if we can create a Python package like matplotlib or seaborn, but for data sonification rather than visualization. Doesn't have to be super complex at the outset -- just organized and scalable.

If we can get this working for 2 or 3 datasets, we can check in with NASA (perhaps via Datanaut Water Cooler Chat) to get general feedback.

To-dos:

• Come up with high-level plan of what we want to do.
• Create and package together sound files and make them callable via functions in package, with data to sonify as an argument.
• Follow Python package-building best-practices.

Small, disrete tasks may be broken down into smaller issues in Issue Tracker.

[sewardlee337]

Leaving this here for reference purposes: http://python-packaging.readthedocs.io/en/latest/

[sewardlee337]

Per commit dc9f8ee3665b980b001ea546bd39a5b5886aca0c, what I want to be able to do is:

• Instantiate an object that ingests data in a dataframe
• choose a couple of arguments for the type of sound you want (a template??)
• Play back the sound as a callable method.

I suck at naming things, so at some point will need help making object and variable names sound better. See sonification-test.ipynb

[lj42]

I'm probably missing something super obvious... is there anything I need to make sure of before running in Jupyter notebook again?

do you have a theme for your object and variable names?

[sewardlee337]

@lj42 Hmmm I don't know off the top of my head and without further investigation. A quick checklist would be...

• Make sure that the folder sound-files is populated with the .wav files.
• Make sure that the package pyglet is installed. (You'd need to run either pip install pyglet or conda install pyglet in your terminal.)

Not sure if that was super helpful. I'm still trying to figure out how to use pyglet myself. It just seemed the most promising out of several options...

[sewardlee337]

@lj42 the way I'm thinking of it is...

• I want to name a generic class of objects
• That ingests data
• Allows the programmer to map the data to sounds

• Can play back the sounds

  This is kind of abstract, but is the class of objects an Instrument? Or Synthesizer? Or is it a Composition? Or maybe a Composer or a Performer?

[lj42]

I've definitely installed pyglet. Aha, I have not populated the sound-files folder that'll be it. I'll report back accordingly.

I think the class of objects could make sense instrument but it's more than that as it's ingesting data too...

Perhaps this is more like a maitre d' or similar as it ingests something (an order) and then outputs something else (dinner) - ah, my vote would be a conductor what do you think ? The conductor ingests data (the musical score) - maps attributes to members of the orchestra (strings: turn up the volume) and ultimately the instrument or synth plays back the sounds (single musician)

[sewardlee337]

For personal reference:

• https://www.youtube.com/watch?v=lJQ3UgcDHto&list=PL1FgJUcJJ03s7kYUy40ydTA9gBnj_KDlK
• https://www.programsinformationpeople.org/runestone/static/publicpy3/Pyglet/sounds.html
• https://pythonhosted.org/pyglet/programming_guide/controlling_playback.html
• http://www.bitforestinfo.com/2017/01/how-to-create-music-player-using-python.html

[sewardlee337]

UPDATE: After a lot of trial-and-error, now figured out a way to play background sound using .play() method for Conductor object.

See commit: 1de67bc385614cbb575d91ec36f1b6e73a9bc2fd

[sewardlee337]

MVP Checklist:

• [x] Play background sound.
• [x] Ingest data, play DINGs.
• [ ] Make a "pause" and "play" button for music player window.
• [ ] Organize into a package that be imported into script (e.g. import datasong)