SonoUno development

SonoUno development: a User-Centered Sonification software for data analysis - Published in JOSS (2024)

https://github.com/sonounoteam/sonouno-desktop

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org
  • Committers with academic emails
    1 of 6 committers (16.7%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

SonoUno is a sonification software for astronomical data presented on a table (txt or csv files). The software is being developed based on the study of other software, standards of accessibility like the ISO 9241-171:2008 (Guidance on software accessibility) and theoretical framework based on literature review and end user tests.

Basic Info
  • Host: GitHub
  • Owner: sonoUnoTeam
  • License: other
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 114 MB
Statistics
  • Stars: 8
  • Watchers: 2
  • Forks: 8
  • Open Issues: 3
  • Releases: 4
Created almost 7 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.md

SonoUno Software

This development is powered by CONICET-Argentina, Universidad de Mendoza-Argentina and REINFORCE.

This work is partially supported by REINFORCE Project. REINFORCE has received funding from the European Union’s Horizon 2020 project call H2020-SwafS-2018-2020 under Grant Agreement no. 872859. The content of this website does not represent the opinion of the European Commission, and the European Commission is not responsible for any use that might be made of such.

Description

Our recent paper published on JOSS: DOI

SonoUno is a sonification software for astronomical data presented on a table (txt or csv files). It has a dedicated webpage with information, manuals and gallery (https://www.sonouno.org.ar/). The software is being developed based on the study of other software (Sonification Sandbox, MathTrax and xSonify) and standards of accessibility like the ISO 9241-171:2008 (Guidance on software accessibility). In order to develop the first approach of a graphical user interface, we perform a theoretical framework based on bibliography of user cases, focused on blind and visual impairment people.

The develop language is Python and we use modular design, in order to do collaborative work. The sonoUno now is multiplatform, tested on windows 10, Ubuntu (16.04 and 18.04), CentOS 7 and Mac (Mojave and Catalina); the development team work continuously to maintain this benefit. The principal goal of the SonoUno is to allow the user to open data files (txt or csv extension), show the plot and sonify the data. At the moment, the sonification is perform by variation of pitch and the sonification settings allow to change the volume and the timbre.

Additionally, SonoUno allow to select a specific range of data on the ‘x’ axis, mark and save point of interest in the data, apply predefined mathematical functions (for example, logarithm and square) and manipulate the data arrays with an Octave interface. In the section settings, the user can configure the plot and some features of the sound.

Finally, the software allows the user to save the plot, a text file with the points marked on the data and a csv file with the plotted data.

Installation

Here we show a quick guide to install the sonoUno. Inside the sonoUno folder, there are some installation instructive, one for each operative system.

  1. Install octave

For Mac you can use brew: brew install octave\ For Ubuntu: sudo apt install octave\ For Centos: yum install epel-release\ yum install octave\ For Windows download the installer from: https://ftpmirror.gnu.org/octave/windows/octave-5.2.0_1-w64-installer.exe . Once is installed you have to set the environment variables.

  1. Check that you have python 3.x installed on your system running ‘python3’ or ‘python’ on a terminal. If you don’t have python:

For Mac: brew install python3\ For Ubuntu: sudo apt install --upgrade python3\ For Centos7: \ To install python3 without interfear with python2:sudo yum install centos-release-scl\ sudo yum install rh-python36\ To enable python3: scl enable rh-python36 bash\ For Windows download the installer from: https://www.python.org/ftp/python/3.8.1/python-3.8.1-amd64.exe\

Note: from here we use python3, you have to use python or python3 depending on the step before.

  1. Check that pip is installed with ‘python3 -m pip -V’. If not:

For Mac, pip is installed with python installation.\ For Ubuntu: sudo apt install python3-pip\ For Centos, pip is installed with python installation.\ For Windows, pip is installed with the executable.

  1. Only for Linux you have to install some other packages:\ Ubuntu: sudo apt install libsdl2-mixer-2.0-0 libsdl2-image-2.0-0 libsdl2-2.0-0 libsdl-ttf2.0-0 libgtk-3-dev\ For ubuntu-16.04:\ python3 -m pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-16.04 wxPython\ For ubuntu-18.04:\ python3 -m pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-18.04 wxPython\ For ubuntu-20.04:\ python3 -m pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-20.04 wxPython\ For ubuntu-22.04:\ python3 -m pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-22.04 wxPython\ Centos: yum install SDL\ pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/centos-7 wxPython

  2. If you want to download the software from the repository install git or download the zip folder.

In addition, you can access the user manual on the web page from: https://www.sonouno.org.ar/usermanual/

Installing and opening the software with Graphic User Interface

The pip version was outdated and throwing an error, so we recommend doing one of the following options:

From github

Download from the webpage: https://github.com/sonoUnoTeam/sonoUno . Go to Downloads and unzip the file.

The other option is to clone the git repository from the terminal with:\ git clone https://github.com/sonoUnoTeam/sonoUno.git

Then, on the terminal, go to the folder which contain the setup.py and install it:\ python3 -m pip install .

To open the sonoUno software:\ cd sonoUno\ python3 sonoUno

Using sonify_bash.py to sonify data files in bash mode

To run this script: cd sonoUno\ python3 sonify_bash.py -t "files_extension" -d "path_to_directory"

Description

The script sonify the first two columns of csv or txt files. The script search inside the folder provided by the user all the data files with the given extension (if not, txt extension is setted as default) and sonify it; then, store the wav files with the same data file name adding '_sound' at the end. The script additionally allow to save the plot with '-p True', as default is setted on False.

Parameters to set

To use the script the directory where the data files are located has to be send when you run the script with the '-d' indication. In addition, if you will sonify data files with csv extension, you must indicate it with the '-t'. To additionally save the plot of each data set, indicate it with '-p True' If you need help to run the script you can write: python3 sonify_bash.py -h

Default parameters

About the data files: If not extension is given, by default search txt files. About the plot, as default the script don't save it. At the moment search all files with the given extension inside the folder, we hope to add the posibility to use a text file with names, or the data file name to sonify only this file.

About the sound the presets are: *SonoUno continuous sound *Celesta as the waveform *A time base of 0.05 We continue working to allow to change this preset from the command line.

How to contribute to the software

All help is welcomed and needed! If you want to contribute contact us at sonounoteam@gmail.com

Report issues or problems with the software

All people could report a problem opening an issue here on GitHub or contact us by email: sonounoteam@gmail.com

Owner

  • Name: SonoUno Team
  • Login: sonoUnoTeam
  • Kind: organization

JOSS Publication

SonoUno development: a User-Centered Sonification software for data analysis
Published
January 24, 2024
Volume 9, Issue 93, Page 5819
Authors
Johanna Casado ORCID
Instituto en Tecnologías de Detección y Astropartículas (CNEA, CONICET, UNSAM), Mendoza, Argentina, Instituto de Bioingeniería, Facultad de Ingeniería, Universidad de Mendoza, Argentina
Gonzalo de la Vega
Independent Researcher, Argentina
Beatriz García ORCID
Instituto en Tecnologías de Detección y Astropartículas (CNEA, CONICET, UNSAM), Mendoza, Argentina, Universidad Tecnológica Nacional - Regional Mendoza, Argentina
Editor
Ivelina Momcheva ORCID
Tags
sonification inclusion astrophysics open source user-centered design graphic user interface

GitHub Events

Total
  • Watch event: 2
  • Member event: 1
  • Push event: 2
  • Create event: 1
Last Year
  • Watch event: 2
  • Member event: 1
  • Push event: 2
  • Create event: 1

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 258
  • Total Committers: 6
  • Avg Commits per committer: 43.0
  • Development Distribution Score (DDS): 0.213
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Johanna Casado j****h@g****m 203
sonoUnoTeam 5****m 34
sonoUno 1****m 13
James Trayford j****d@j****k 4
Gonzalo A. de la Vega g****a@g****m 3
Ivelina Momcheva i****a@g****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 7
  • Total pull requests: 7
  • Average time to close issues: about 1 year
  • Average time to close pull requests: 4 days
  • Total issue authors: 6
  • Total pull request authors: 4
  • Average comments per issue: 1.43
  • Average comments per pull request: 0.43
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • smangham (2)
  • pedro-acunha (1)
  • scotgl (1)
  • DiscoPhreak (1)
  • nhurleywalker (1)
Pull Request Authors
  • johicasado (4)
  • james-trayford (1)
  • sonoUnoTeam (1)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

setup.py pypi
  • Pillow *
  • cycler *
  • kiwisolver *
  • matplotlib *
  • numpy *
  • oct2py *
  • pandas *
  • pygame *
  • pyparsing *
  • python-dateutil *
  • pytz *
  • six *
  • wxpython_url ,