herald

README

announce your samples

---

---

this is a proof of concept release of a desktop app for scheduling CLIMB jobs

Overview

The basic idea is to announce samples to APIs and track responses.

You create a sample via the Herald app. Once you have a sample on record, you can tag it with processes (e.g. sequence it, analyse it, upload it...). You can then tell Herald to announce the sample to the tagged processes, which it will monitor and update the sample record accordingly.

When announcing a sample, Herald will:

• check the sample record
• evaluate the tagged processes and create an execution order
• formulate the correct gRPC messages and submit them to the process APIs
• wait for responses, update the sample record and submit the next message

Installation

Use a release

Herald is packaged as a desktop application (using lorca). Just download a release for your platform.

note: lorca apps require Chrome/Chromium >= 70 to be installed on your system.

Building from source

You will need the Go tool chain (Herald tested with v1.16) to build from source.

git clone https://github.com/will-rowe/herald
cd herald
make all

Documentation

Docs are available via read the docs and are being written during development.