oceanbench

README

Readme

Video Grinder (VidGrind) is a cloud service for receiving and storing media and data from AusOcean devices.

VidGrind is written in Go and runs on Google App Engine Standard Edition (part of Google Cloud.)

VidGrind's predecessor is NetReceiver (from which it is derived).

Installation and Usage

Before you begin, make sure you have git, go and npm installed. If not, you can follow the official guides:

• git website
• go website
• npm website

1. Clone the repository:

   git clone https://github.com/ausocean/cloud.git
   

2. Change to the project directory:

   cd cmd/oceanbench
   

3. Install node dependencies from package.json:

   npm install
   

4. Compile typescript:

   npm run build
   

5. Compile Go:

   go build
   

6. Run a local instance:

   ./vidgrind --standalone
   
   

See Also

• VidGrind service
• NetReceiver service
• AusOcean

License

Copyright (C) 2019-2023 the Australian Ocean Lab (AusOcean).

It is free software: you can redistribute it and/or modify them under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

It is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with NetReceiver in gpl.txt. If not, see http://www.gnu.org/licenses.

Documentation

Overview

Ocean Bench is a cloud service for analyzing ocean data.

Data can be accessed and played.

/search to search for any data.
/play to play audio or video daa

Ocean Bench can also be run in standalone mode without App Engine:

./oceanbench -standalone

Other command-line flags available in standalone mode:

[-debug]        enables verbose output for debugging.
[-host string]  host name we're running on (localhost by default).
[-port int]     host port we're listening on (8080 by default).
[-gps string]   GPS receiver serial port and enables GPS mode, e.g. COM4 or /dev/ttyUSB.
[-baudRate int] serial device baud rate (9600 by default).
[-loc string]   latitude,longitude of the GPS receiver in decimal degrees format.
[-alt float]    altitude of the GPS receiver. Negative numbers signify depths (0 by default).

The PORT environment variable can be used to set the default port number.