This software designs acoustic sensor networks for animal monitoring.
Date: 2014-05-30
Author: Greg Burgess, Martin W. Pedersen, Kevin Weng
Maintainer: Greg Burgess <[email protected]>, Martin W. Pedersen <[email protected]>

This package is useful in the design phase of an acoustic sensor network. The package requires information about bathymetry and detections conditions (detection function) and generates in return an optimal sensor configuration that accounts for fish behavior and detection shadows. Source code for building the package and installing a web-based GUI can be downloaded from the URL below.

License: GNU General Public License, GPL (>= 2)

Requires: R version 3.0.2 or later (3.0.2 supported)
          Ubuntu 14.04.1 (supported)
          
== The R package (for command line interface via R) ==
To build the R package run the bash script from the acoustic-deploy directory using the commands:

sudo ./scripts/install.sh
sudo ./scripts/package.sh

This will install the software required to build the R package (check ./scripts/install.sh for details), and then build the package creating the tarball acoustic_1.0.tar.gz. The package is then installed using the command:

sudo R CMD INSTALL acoustic_1.0.tar.gz

From R you should now be able to load the package with the command:

library(acoustic)

To run an example run:

example(acoustic)

For more example options try:

?acousticTest

For make your own acoustic design read the help for the acousticRun function, i.e. run

?acousticRun

And get inspiration for your script by checking the code for the acousticTest function by running:

acousticTest


== Acoustic web app (GUI) ==
Supported Browsers:
          Google Chrome 36.0.1985.125 or later (36.0.1985.125 supported)
          Mozilla Firefox Version 29.0.1 or later (29.0.1 supported)
          
First, make sure you have built the program with the install.sh script (see above).
To start the acoustic web app, run the following command from the acoustic-deploy directory:

sudo Rscript Publicserver.R

This will start the server while the script appears to be "hanging" and not doing anything, however if you interact with the web app using a browser the server activity will be shown in this prompt.

The URL for the web app is "{baseURL}/custom/static/pages/index.html", where {baseURL} is the IP of your computer or the URL you have assigned to it.

Note that the server is initally configured to work with the files found here: 
ftp://ftp.soest.hawaii.edu/pjohnson/MultibeamSynthesis_V19/netcdf/himbsyn.bathy.v19.grd.zip
ftp://ftp.soest.hawaii.edu/pjohnson/MBS19/netcdf/himbsyn.bathytopo.1km.v19.grd.zip
ftp://ftp.soest.hawaii.edu/pibhmc/website/data/pria/bathymetry/Palmyra_40m.grd.zip

extract these files to the src folder, as such:

src/himbsyn.bathy.v19.grd/himbsyn.bathy.v19.grd
src/himbsyn.bathytopo.1km.v19.grd/himbsyn.bathytopo.1km.v19.grd
src/palmyra_40m.grd

To use your own bathymetry files with the GUI, modify the pages/Form.xml file.  
Add an <Option> tag within the inputFile <Field><Options> tag to include the label (display name) and file path to your bathymetry files.
The pages/Form.xml file is also where you can edit the default values for your GUI.
After modifying the Form.xml file, it may be necessary to restart your server to see the changes take effect.