BugDoc

BugDoc is a framework for finding root causes of errors in computational pipelines.

For more detailed information about the framework, please refer to our SIGMOD paper:

BugDoc: Algorithms to Debug Computational Processes. Raoni Lourenço, Juliana Freire, and Dennis Shasha. In ACM SIGMOD, 2020.

Mission, Vision and Problem Statements

Our mission is to improve the quality of science in general by alleviating the burden of debugging computational pipelines manually.

BugDoc will be a must-have item in the computational pipeline designer's toolkit. It will be always open and customizable to adhere to any workflow system.

Given a set of computational pipeline instances, some of which led to bad or questionable results, our goal is to find the root causes of failures, possibly by creating and executing new pipeline instances.

Team

• Raoni Lourenço (New York University)
• Juliana Freire (New York University)
• Dennis Shasha (New York University)

Contributions

We are currently managing contributions by issues, more detailed procedure will be included soon.

How To Build

This package works with Python 3.6 or greater.

Installing the API

To install latest development version of BugDoc's API:

$ pip install -e bugdoc_api

Installing the Command-line interface

To install the simple command-line interface:

$ pip install -e bugdoc_cli

Installing from PyPI

You can install the latest stable version of BugDoc's API library directly from PyPI using PIP.

$ pip install bugdoc

Documentation

The documentation of BugDoc's API with some examples can be found here.