TWiki> Public Web>DpHipe (revision 22)EditAttach


Splash screen of HIPE

HIPE stands for Herschel Interactive Processing Environment and is a result of an effort to meet the desires expressed within the User Vision document. The intent is to replace JIDE with HIPE.

These pages give the developer a quick overview of HIPE as well as an introduction on how to contribute to it.

The name HIPE was chosen for several reasons including its resemblance (at least in pronounciation) with hype; the latter being defined as:

  • blatant or sensational promotion
  • extravagant or intensive publicity or promotion
which sounds ... just about right smile


This section explains the philosophy behind the framework and provides a brief overview of its fundamental elements. The aim is to enable you to make contributions to HIPE.



HIPE is an extendible environment: you can make contributions to it by developing tools that manipulate data, a new perspective, a new view, a new data visualization component and so forth. Simply by registering such a component in a jython package, HIPE automatically picks up your contribution.

Blue led Adding Tools and Tasks

This section explains the following:

  • How you can create a tool and register it, so that it becomes associated to specific data.
  • How you can make HIPE aware of an existing Task.
  • How your task can react better to an active data element.
  • The default task dialogue window.
  • How you can implement and contribute a specific parameter editor.
  • How to deprecate tasks and task parameters.


Blue led Adding Components to Views

The contents of certain views can be extended by developers, such as the Outline View and the Editor Area. Both are examples of the system reacting on a data selection made by the user.

Here we explain how you can contribute to the outline view and the editor area.


Blue led Adding Views

You can develop new views and add them to the work-bench of HIPE. This section briefly explains how to do this.


Blue led Adding perspectives

If you think that a set of (new) views should be presented in standard layout, you can do so by creating a new perspective. Such a perspective defines how these views are laid out in tabs and split panes. This section briefly explains how to contribute a new perspective.


Blue led Adding preferences

This section explains the relationship between preferences and properties in HIPE, and how you can contribute to:

  • Introduce preferences and develop a GUI panel for them in your module.
  • Make a bridge between preferences and existing properties.
  • Use preferences in client code.
  • Listen to changes in preferences to adapt your functionality dynamically.


Blue led Registring your contribution

You must register your contribution (whether it is a tool, perspective, view, component to views or component to the editor area) to HIPE to make it part of the application. Registering means that you have to write add an entry to the jython package module (aka within the sub-system that is under your control.

This section explains the workings of the registry works and how it can automatically find your contribution.


Blue led Common utilities

This section explains additional useful information for HIPE developers, both for contributors with views, editors, etc. and for maintainers of the HIPE framework.


Blue led Conventions

Warning: Can't find topic Public.DpHipeConventions

Developers Corner

Warning: Can't find topic Public.DpHipeDevelopers

Trouble shooting

Warning: Can't find topic Hcss.DpHipeTroubleShooting

Your valuable feedbacks

Warning: Can't find topic Hcss.DpHipeFeedbacks

Hipe workshops

Hcss.Here you can find some content of HIPE workshops. They may help you introducing into the tool also:

  • Workshop held in July 2008.
  • Workshop held in September 2008 at ESAC.
Form definition 'DocumentMetadataForm' not found
Edit | Attach | Watch | Print version | History: r43 | r24 < r23 < r22 < r21 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r22 - 2010-04-29 - DavideRizzo
This site is powered by the TWiki collaboration platform Powered by Perl