Skip to content

Latest commit

 

History

History
151 lines (78 loc) · 4.16 KB

File metadata and controls

151 lines (78 loc) · 4.16 KB

Welcome to Ziggy!

Ziggy is "A Pipeline management system for Data Analysis Pipelines." This is the user guide and assorted documentation.

Table of Contents

  1. Super-Basic Introduction

  2. Prerequisites and System Requirements

  3. Quick Start

  4. Pipeline Architecture

  5. Downloading and Building Ziggy

  6. Configuring a Pipeline

    6.1. Pipeline Algorithms

    6.2. Python Pipeline Algorithms

    6.3. Other Pipeline Algorithms

    6.5. Algorithm Parameters

    6.4. The Datastore

    6.6. Remote Environments

    6.7. Pipelines and Nodes

  7. Build System for your Pipeline

  8. Running the Cluster

  9. Using the Ziggy Console, Part 1

    9.1​. Starting a Pipeline

    9.2​. The Instances Panel

    9.3.​ Changing the Start and End Nodes

    9.4.​ Changing Algorithm Parameter Values

    9.5.​ Organizing Pipelines and Parameter Sets

    9.6. The Edit Pipeline Dialog Box

    9.7. The Datastore Control Panel

  10. Intermediate Topics

    10.1. The Datastore and the Task Directory

    10.2. Setting up a Relational Database Management System (RDBMS)

  11. Troubleshooting Pipeline Execution

    11.1​. Log Files in Ziggy

  12. Using the Ziggy Console, Part 2: Troubleshooting

    12.1.​ Monitoring Tab

    12.2.​ Alerts Panel

    12.3.​ Log Files Display

    12.4. Performance Report

    12.5.​ Re-Run or Resume a Failed Task

    12.6.​ Halting Tasks

  13. High Performance Computing

    13.1. The Remote Execution Dialog Box

    13.2. HPC Cost Estimation

  14. Cloud Computing (TBD)

  15. Data Receipt

    15.1​. Execution Flow

    15.2.​ Data Receipt Display

  16. Event Handler

    16.1​. Introduction to Event Handlers

    16.2​. Defining Event Handlers

    16.3​. Event Handler Examples

    16.4​. Sending Event Information to Algorithms

  17. Reports and Performance Tracking

    17.1​. Metrics

    17.2. Performance Report

  18. Alternative User Interface Options

    18.1​. Command-Line Interface

  19. Security (TBD)

  20. Ziggy's Dustier Corners

    20.1​. More on the Relational Database

    20.2​. More on Parameter Sets

    20.3​. Parameter Overrides

    20.4​. Redefining a Pipeline

    20.5. Creating Ziggy Nicknames

    20.6. Advanced Unit of Work Configurations

    20.7. Software Version Tracking

    20.8. Ziggy's use of HDF5

  21. Contact Us

Appendix A. The Properties File