Welcome to DataSounds’s documentation!¶
Contents:
Readme¶
DataSounds¶
Get sounds from temporal series, or another sequecial data. Visit us at www.datasounds.org.
Installation¶
At the command line:
$ git clone http://github.com/DataSounds/DataSounds.git
$ cd DataSounds
$ python setup.py install
Or using pip (program to easily install Python packages), which dinamicaly access the Python Package Index PyPI.
$ pip install DataSounds
Or, with the controled python ecosystem virtualenvwrapper. After install virtualenvwrapper, follow the instructions below:
$ mkvirtualenv DataSounds
$ workon DataSounds
(DataSounds) $ git clone http://github.com/DataSounds/DataSounds.git
(DataSounds) $ cd DataSounds
(DataSounds) $ python setup.py install
Dependencies¶
Numpy is a necessary packages to use DataSounds.
Numpy can be installed using pip. If you use virtualenvwrapper, this could be done inside your virtual environment. Normally, Numpy is installed as a dependency of DataSounds and should work if it was successfully compiled.
Usage¶
Simple usage¶
Simple Python script to use DataSounds module to sonify dataset.
from DataSounds.sounds import get_music, w2Midi
import numpy as np
data = np.random.rand(24)
music = get_music(data)
w2Midi('my_musica_data', music)
w2Midi writes a .midi file inside the current directory. In this case my_music_data.midi will be saved on disk.
Play MIDI files inside Python is a little bit tricky, and it is possible using the compilation of Pygame library.
To not bring this dependency inside DataSounds, we try to use the system player. For Linux you could install timidity (apt-get install timidity) or use totem with fluid-soundfont-gm. For OS X users, we try to use the simple open or timidity, and for windows users you should install timidity.
DataSounds comes with default pre settings of get_music function, which may be changed accordingly the user prefferences. The help function displays:
Setting parameters¶
Parameters can be changed if you want to use DataSounds to differentiate two or more series. This usage requires the difference of instruments and also the number of octaves of each series. For example:
This example shows how to use different instruments for each series (e.g. Acoustic Grand Piano for ts_a and Rock Organ for ts_b.
The usage of octaves can better perform distinction between values. We can correlate this parameter as colorbars, if you have a colorbar with 7 colors to represent more than 7 distinct values, your display may be masking some results. Same logical procedure can be adopted here.
List of MIDI instruments¶
Numbers at left side of instrument name are already written considering Python listing index (e.g. first number is == 0).
Piano | |
---|---|
0 Acoustic Grand Piano | 1 Bright Acoustic Piano |
2 Electric Grand Piano | 3 Honky-tonk Piano |
4 Electric Piano 1 | 5 Electric Piano 2 |
6 Harpsichord | 7 Clavinet |
Chromatic Percussion | |
---|---|
8 Celesta | 9 Glockenspiel |
10 Music Box | 11 Vibraphone |
12 Marimba | 13 Xylophone |
14 Tubular Bells | 15 Dulcimer |
Organ | |
---|---|
16 Drawbar Organ | 17 Percussive Organ |
18 Rock Organ | 19 Church Organ |
20 Reed Organ | 21 Accordion |
22 Harmonica | 23 Tango Accordion |
Guitar | |
---|---|
24 Acoustic Guitar(nylon) | 25 Acoustic Guitar(steel) |
26 Electric Guitar(jazz) | 27 Electric Guitar(clean) |
28 Electric Guitar(muted) | 29 Overdriven Guitar |
30 Distortion Guitar | 31 Guitar Harmonics |
Bass | |
---|---|
32 Acoustic Bass | 32 Electric Bass (finger) |
34 Electric Bass (pick) | 35 Fretless Bass |
36 Slap Bass 1 | 37 Slap Bass 2 |
38 Synth Bass 1 | 39 Synth Bass 2 |
Strings | |
---|---|
40 Violin | 41 Viola |
42 Cello | 43 Contrabass |
44 Tremolo String | 45 Pizzicato Strings |
46 Orchestral Harp | 47 Timpani |
Enseble | |
---|---|
48 String Ensemble 1 | 49 String Ensemble 2 |
50 Synth Strings 1 | 51 Synth Strings 2 |
52 Choir Aahs | 53 Voice Oohs |
54 Synth Choir | 55 Orchestra Hit |
Brass | |
---|---|
56 Trumpet | 57 Trombone |
58 Tuba | 59 Muted Trumpet |
60 French Horn | 61 Brass Section |
62 Synth Brass 1 | 63 Synth Brass 2 |
Reed | |
---|---|
64 Soprano Sax | 65 Alto Sax |
66 Tenor Sax | 67 Baritone Sax |
68 Oboe | 69 English Horn |
70 Bassoon | 71 Clarinet |
Pipe | |
---|---|
72 Piccolo | 73 Flute |
74 Recorder | 75 Pan Flute |
76 Blown bottle | 77 Shakuhachi |
78 Whistle | 79 Ocarina |
Synth Lead | |
---|---|
80 Lead 1 (square) | 81 Lead 2 (sawtooth) |
82 Lead 3 (calliope) | 83 Lead 4 chiff |
84 Lead 5 (charang) | 85 Lead 6 (voice) |
86 Lead 7 (fifths) | 87 Lead 8 (bass + lead) |
Synth Pad | |
---|---|
88 Pad 1 (new age) | 89 Pad 2 (warm) |
90 Pad 3 (polysynth) | 91 Pad 4 (choir) |
92 Pad 5 (bowed) | 93 Pad 6 (metallic) |
94 Pad 7 (halo) | 95 Pad 8 (sweep) |
Synth Effects | |
---|---|
96 FX 1 (rain) | 97 FX 2 (soundtrack) |
98 FX 3 (crystal) | 99 FX 4 (atmosphere) |
100 FX 5 (brightness) | 101 FX 6 (goblins) |
102 FX 7 (echoes) | 103 FX 8 (sci-fi) |
Ethnic | |
---|---|
104 Sitar | 105 Banjo |
106 Shamisen | 107 Koto |
108 Kalimba | 109 Bagpipe |
110 Fiddle | 111 Shanai |
Percussive | |
---|---|
112 Tinkle Bell | 113 Agogo |
114 Steel Drums | 115 Woodblock |
116 Taiko Drum | 117 Melodic Tom |
118 Synth Drum | 119 Reverse Cymbal |
Sound effects | |
---|---|
120 Guitar Fret Noise | 121 Breath Noise |
122 Seashore | 123 Bird Tweet |
124 Telephone Ring | 125 Helicopter |
126 Applause | 127 Gunshot |
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/DataSounds/DataSounds/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
DataSounds could always use more documentation, whether as part of the official DataSounds docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/DataSounds/DataSounds/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up DataSounds for local development.
Fork the DataSounds repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/DataSounds.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv devDS $ cd DataSounds/ $ python setup.py develop
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass through tests, including testing other Python versions with tox:
$ python setup.py test $ tox
To get the necessary packeges just install it as follows inside yours virtualenv:
$ pip install -r dev-requirements.txt
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/DataSounds/DataSounds/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
DataSounds development Lead¶
- Arnaldo Russo <arnaldo@datasounds.org>
- Luiz Irber <luiz@datasounds.org>
Contributors¶
None yet. Why not be the first?