Readme

This repository contains AusOcean's cloud services and support packages.

Ocean Bench

Ocean Bench is AusOcean's cloud service for analyzing and managing ocean data, and managing AusOcean devices.

Instructions for building Ocean Bench can be found under cmd/oceanbench.

Environment Configuration

OceanBench supports a .env file in the working directory (e.g. cmd/oceanbench/.env) for local development. Copy the example file to get started:

cp cmd/oceanbench/.env.example cmd/oceanbench/.env

This sets variables like OAUTH2_CALLBACK so you don't need to export them in your shell. The .env file is gitignored and will not be committed.

To deploy OceanBench:

gcloud app deploy --version V --project oceanbeach oceanbeach.yaml

Currently, OceanBench utilizes datastores in two projects, namely ausocean and vidgrind. Deploying datastore indexes therefore requires running two commands.

cp vidgrind_index.yaml index.yaml
gcloud app deploy --project vidgrind index.yaml

cp ausocean_index.yaml index.yaml
gcloud app deploy --project ausocean index.yaml

There is an additional testing database which is part of the ausocean project. These indexes can be updated using the ausocean_test.yaml file. This index file contains both the indexes for vidgrind entities as well as ausocean entities.

cp ausocean_test_index.yaml index.yaml
gcloud datastore indexes create --project=ausocean --database=test index.yaml

To clean up indexes:

cp vidgrind_index.yaml index.yaml
gcloud datastore indexes cleanup --project vidgrind index.yaml

Documentation

Service documentation is built using VitePress and is located in the docs directory.

To run the documentation locally:

1. Navigate to the docs directory:

   cd docs

2. Install dependencies:

   npm install

3. Start the development server:

   npm run docs:dev

The documentation will be available at http://localhost:5173.