Personal tools
You are here: Home → Documentation
 

Documentation

The Kepler project strives to provide accurate and useful documentation. If you cannot find the answer to your question in the documentation, or if you have suggestions or comments about the documentation itself, please contact us.

The Kepler Getting Started Guide, Actor Reference and User Manual described below are shipped with Kepler, but can also be downloaded from this page. The documents require a PDF reader. If you do not currently have a PDF reader installed, a free copy of Adobe Acrobat Reader is available here.

 

 We recommend that new users:

  1. Read the Getting Started Guide.
  2. Browse the Kepler User Manual and the Kepler Actor Reference guide.
  3. Read the comprehensive Ptolemy documentation. The "Using Vergil" chapter provides a good introduction to the application's graphical interface.
  4. Run some Kepler demos. The application ships with a "demos/getting-started" directory that contains a number of useful, sample workflows. Currently the demos dir is located in KeplerData/workflows/module/outreach-2.x.y/
  5. Read the Kepler technical papers.

Getting Started Guide

The Getting Started with Kepler guide is a tutorial style manual covering downloading and installing Kepler, the user interface, and basic operations such as opening, running, editing, and building scientific workflows.

Kepler Actor Reference

The Kepler Actor Reference contains documentation for all of the actors that ship with the Kepler standard library. The Table of Contents is arranged by function and the actors are categorized as they are in the Kepler library (e.g., "Data Input", "Data Output", etc). The reference pages are ordered alphabetically by actor name, and actors can be browsed by name via the PDF bookmarks, or with the alphabetical index at the end of the reference.

Kepler User Manual

The Kepler User Manual is a comprehensive Kepler reference with chapters dedicated to the Kepler project and history; installing and running Kepler; scientific workflows;  working with existing scientific workflows; building scientific workflows with existing actors; working with data sets; using remote computing resources (the grid and Web services); mathematical, data analysis, and visualization packages (R, MATLAB, ImageJ, GIS systems); domain specific workflows (examples of Kepler workflows prototyped or built for chemistry, ecology, geology, molecular biology, oceanography, and phylogeny domains); creating new actors; and using R in Kepler.

 

Kepler Optional Suites and Modules

There are several optional suites and modules that can be added to your installation of Kepler.  In general, these provide additional features that are specific to a particular task or problem domain. Documentation for each suite is available below.

BioKepler Documentation

The BioKepler Suite facilitates the development of Kepler workflows for the integrated execution of bioinformatics applications in distributed environments. It contains a specialized set of actors for running bioinformatics tools, directors providing distributed data-parallel (DDP) execution on different computational resources, and example workflows demonstrating how to use these actors and directors. More information can be found at http://www.biokepler.org/

Sensor View Documentation

The Sensor View Suite enables monitoring and controlling sensors; sensor data analysis, modeling, visualization, documentation, archival, and archive retrieval.

Reporting Documentation

The Reporting Suite provides a way to create reports from Kepler workflows, to tag workflows, and to tag, search, export, import, upload, and delete workflow runs.

Workflow Run Manager Documentation

The Workflow-Run-Manger is a GUI for managing workflow run execution history or "workflow runs" that are stored using the Provenance module.

Provenance Documentation

The Provenance suite tracks lineage of workflows and their data products.

Tagging Documentation

The Tagging suite adds additional features to the Kepler application. It provides a way to use semantic tagging for workflows and workflow runs.

Workflow Scheduler GUI Documentation

The Workflow Scheduler GUI Suite provides a way to schedule workflows for periodic, remote execution on a server running Kepler.

Master-Slave Documentation

The Master-Slave module was created to distribute parts of a workflow to be remotely executed on other machines.

Serpens Suite Documentation

Serpens Suite in Kepler is implemented by Poznań Supercomputing and Networking Center, Poland to support Grid workflow execution. Its provides actors in three modules, namely gLite, UNICORE and Vine Toolkit, to support corresponding Grid workflows.

Developer Reference

Please see the Developer section for more information about obtaining the Kepler source code, building Kepler, and writing and contributing code.

Document Actions