Setup

Setup for users

Installation on the production machine cetacean of this code is done with the deploy-soundscape repository by the developer. This includes any necessary setup of the AWS account and the installation of the code that shares data with the Pacific Ocean Sound Recordings AWS Open Data Sharing program. Most of the code is run nightly and should be transparent to the user. The code is run as the user pam on cetacean.shore.mbari.org.

Running the code

To run any code manually, you can activate the conda environment from the machine cetacean.shore.mbari.org. The code is already installed there and the AWS account is already setup.

ssh pam@cetacean.shore.mbari.org

Once logged in, you can activate the conda environment and run the code with the following commands:

conda activate soundscape-opendata
cd /opt/pam/deployed/code/soundscape-opendata
python opendata/run.py --help

Setup for developers

The instructions below are for installing on a local machine for development. You can safely ignore the instructions below if you are not a developer and are running the code on cetacean.shore.mbari.org. In that case, the code is already installed. and you can run the code with the command python opendata/run.py after activating the conda environment. with conda activate soundscape-opendata

Python requirements

You will need python version 3.6 or higher and the package manager conda.

To verify both are installed, check on a command line

python --version

pip --version

AWS requirements

Install your AWS keys to a profile, e.g. soundscapeopendata using the documentation here.

Install steps

Install with

git clone https://github.com/mbari-org/soundscape-opendata
cd soundscape-opendata 
conda env create
conda activate soundscape-opendata
export HOME=/opt/pam/deployed

The tool should now be installed. You can check by running

python opendata/run.py --version

which should output something like:

opendata, version 1.4.0