SonoCleaner is a tool for correcting artifacts in measurements obtained from sonomicrometry.
This tool has an accompanying paper.
Please see the User's guide for a tutorial and other information on using the program.
Currently only MacOS and 64-bit Linux (x86_64) are supported.
This tool is distributed as a binary executable. To run the program, one only needs to download and run the executable for your operating system, given that all the program's dependencies are installed.
This program depends on the gtk+3 library for its graphical user interface.
Gtk+3 can be obtained on MacOS through the Homebrew package manager.
Homebrew requires a recent version of OS X. At the time of writing (2017), Homebrew requires OS X 10.11 or higher.
The installation and use of Homebrew requires use of the terminal. See their installation instructions or their documentation for more information.
Once Homebrew is installed, paste and run the following in the terminal to install gtk+3:
brew install gtk+3 adwaita-icon-theme
The packages providing gtk+3 are listed below for several distributions.
Ubuntu, Debian: libgtk-3-0
Fedora: gtk3
The program is written in Haskell and is built with Stack.
The dependencies for building the program are: stack, cairo, gtk3, pango, and pkg-config.
On Debian linux, these dependencies translate to the following packages:
haskell-stack libcairo2-dev libgtk-3-dev libpango1.0-dev pkg-config
On MacOS, the following Homebrew 'formulae' suffice:
haskell-stack gtk+3 adwaita-icon-theme
After installing Stack, you may need to upgrade to the latest version:
stack upgrade --install-ghc
Once the depenencies are installed, clone the source repository and change directory to the SonoCleaner project folder.
git clone https://github.com/awjchen/SonoCleaner.git SonoCleaner
cd SonoCleaner
Then, use Stack to build the program.
stack install --install-ghc
The first build of the program will take much longer as Stack downloads the program's dependencies and builds them from source, but caches them for future builds.
If successful, these steps will place a SonoCleaner executable in the .local/bin directory of your home folder.
Bug reports, feature requests, and general feedback and suggestions are welcome.
For code contributions, please get in touch before beginning any work.