From 58ff328e48073aa919e1d74354bfe6deeb8f7072 Mon Sep 17 00:00:00 2001 From: David Runge Date: Sat, 23 Apr 2016 14:01:42 +0200 Subject: README.rst: Moving README to restructuredtext, updating, removing TODO. --- README.md | 47 ------------------------------------------- README.rst | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 47 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index d6be4de..0000000 --- a/README.md +++ /dev/null @@ -1,47 +0,0 @@ -# thesoundofpeople - -## About -Supercollider classes for interacting with data sets from [OpenSNP](https://opensnp.org) (parsing, retrieving metadata, rendering audio from, etc.). -**Note:** *This is a prototype! It is developed on Linux using JACK, therefore the following features have only been tested there!* - -## Features -- Parse 23andme files, write them to a different - optimized for the work with *The Sound Of People* - format. -- Loading the contents of both types of files (parsed and read) into a SuperCollider Dictionary. This will require **a lot** of RAM. Get ready for ~5,7GB (*parsing*) and ~4,7GB (*reading*). -The amount will increase during playback - you will most likely end up using ~6,0GB! -- Retrieve metadata (at the moment only resolvers for SNPs) for SNPs and the data sets -- Rendering sound from positions (or rather: bases/base pairs at a position on a chromosome) of up to 25 chromosomes at the same time. -- Possible audio setups are: **2**, **4**, **6**, **8** and **12** speakers -- A GUI showing the current speaker setup and currently playing SNP on chromosomes - -## GUI -The GUI is still pretty minimalistic and currently just - non-interactively - showing which SNP is playing on which chromsome (and thus also on which speaker). -![GUI](https://git.sleepmap.de/thesoundofpeople.git/plain/thesoundofpeople-gui.png) - -## Audio -For audio samples (only stereo - and please bear in mind that the main focus has been multi-channel use for this application!) visit [Soundcloud](https://soundcloud.com/thesoundofpeople). - -## Installation - -Clone this repository to somewhere sclang will pick it up on recompiling its class library: - - cd ~/.local/share/SuperCollider/Extensions/local - git clone git://sleepmap.de/thesoundofpeople.git - -If the local folder doesn't exist, create it, otherwise you can also directly clone into the Extensions folder (the folder and all of its children will get picked up on recompile). -Symlinking is fine, too! - - cd ~/some/other/directory - git clone git://sleepmap.de/thesoundofpeople.git - cd ./local/share/SuperCollider/Extensios/local/ - ln -s ~/some/other/directory/thesoundofpeople . - -## Usage -Go to the cloned directory and open **thesoundofpeople.scd** in your favorite SuperCollider IDE. -All further steps are explained there. - -## TODO -- GUI buttons for start/pause/stop, file chooser for the file to parse/read, option for choosing/reloading the speaker setup -- Add .schelp files -- fine grain the synthesizers used, so each chromosome will become more distinct (currently only X, Y and MT are very recognizable) -- use a set of filters based upon the form of each chromosome and its "interesting areas" -- make updating resolvers less RAM consuming (and thus usable) diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..8ea0809 --- /dev/null +++ b/README.rst @@ -0,0 +1,67 @@ +thesoundofpeople +################ + +||supercollider classes for interacting with data sets from |opensnp| (parsing, retrieving metadata, rendering audio from, etc.). + + **Note:** *This is a prototype! It is developed on Linux using JACK, therefore the following features have only been tested there!* + +Features +________ +- Parse 23andme files, write them to a different - optimized for the work with **The Sound Of People** - format. +- Loading the contents of both types of files (parsed and read) into a SuperCollider Dictionary. This will require **a lot** of RAM. Get ready for ~5,7GB (*parsing*) and ~4,7GB (*reading*). The amount will increase during playback - you will most likely end up using ~6,0GB! +- Retrieve metadata (at the moment only resolvers for SNPs) for SNPs and the data sets +- Rendering sound from positions (or rather: bases/base pairs at a position on a chromosome) of up to 25 chromosomes at the same time. +- Possible audio setups are: **2**, **4**, **6**, **8** and **12** speakers +- A GUI showing the current speaker setup and currently playing SNP on chromosomes + +GUI +___ +The GUI is still pretty minimalistic and currently just - non-interactively - showing which SNP is playing on which chromsome (and thus also on which speaker). + +.. figure:: https://git.sleepmap.de/thesoundofpeople.git/plain/thesoundofpeople-gui.png + :alt: The Sound Of People GUI + + The Sound Of People GUI + +Audio +_____ +| For audio samples (only stereo - and please bear in mind that the main focus has been multi-channel use for this application!) visit |soundcloud| + +Installation +____________ +Clone this repository to somewhere sclang will pick it up on recompiling its class library: + + .. code:: bash + + cd ~/.local/share/SuperCollider/Extensions/local + git clone git://sleepmap.de/thesoundofpeople.git + +If the local folder doesn't exist, create it, otherwise you can also directly clone into the Extensions folder (the folder and all of its children will get picked up on recompile). +Symlinking is fine, too! + + .. code:: bash + + cd ~/some/other/directory + git clone git://sleepmap.de/thesoundofpeople.git + cd ./local/share/SuperCollider/Extensios/local/ + ln -s ~/some/other/directory/thesoundofpeople . + +Usage +_____ +Go to the cloned directory and open **thesoundofpeople.scd** in your favorite SuperCollider IDE. +All further steps are explained there. + + +.. |supercollider| raw:: html + + SuperCollider + +.. |opensnp| raw:: html + + SuperCollider + +.. |soundcloud| raw:: html + + Soundcloud + + -- cgit v1.2.3