Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tom-tan/drill-hawk

A visualizer of workflow execution records for CWL
https://github.com/tom-tan/drill-hawk

common-workflow-language commonwl cwl visualizer

Last synced: 28 days ago
JSON representation

A visualizer of workflow execution records for CWL

Awesome Lists containing this project

README

        

# DrillHawk

It is a web application to visualize previous workflow execution records collected by [CWL-metrics](https://inutano.github.io/cwl-metrics/).
It enables us to take a [drill down](https://en.wikipedia.org/wiki/Drill_down) approach in which we first check the list of collected workflow execution records, compare several execution records using workflow metrics, and analyze the specific execution records by using [Kibana](https://www.elastic.co/kibana).

# Requirements

- Python 3.7
- Elasticsearch that stores workflow metrics collected by CWL-metrics or its compatible metrics collector
- Kibana
- [Setup](doc/manual.md) is needed to drill down from DrillHawk

# How to start DrillHawk server
```console
$ git clone https://bitbucket.org/dynreconf/drill-hawk.git
$ cd drill-hawk
$ pip install -r requirements.txt
$ export ES_INDEX_NAME=workflow
$ export ES_ENDPOINT=10.0.0.100:9200
$ export KIBANA_ENDPOINT=10.0.0.100:5601
$ sed "s/\${KIBANA_ENDPOINT}/${KIBANA_ENDPOINT}/" static/js/config.js.template > static/js/config.js
$ python app.py
```

You can see the list of collected workflow execution records at `http://localhost:5001/`.
You can configure the index name and the endpoint of Elasticsearch by using `ES_INDEX_NAME` and `ES_ENDPOINT`, `KIBANA_ENDPOINT` respectively.

# Starting DrillHawk server using docker-compose
If you prefer using docker containers, you can start DrillHawk server by using the following command:

```console
$ docker-compose up
```

# Third Party Software Licenses

## The BSD 3-Clause License

https://opensource.org/licenses/BSD-3-Clause

- D3.js (version 4.13.0) ... `static/js/d3.v4.min.js`

## The MIT License (MIT)

https://opensource.org/licenses/MIT

- Bootstrap (version 4.1.3) ... `static/js/bootstrap.min.js`
- DataTables (version 1.10.18) ... `static/js/datatables.min.js`

# Acknowledgement

This work was supported by JST CREST Grant Number JPMJCR1501, Japan.