|
|
## How to start
|
|
|
To start the GUI change directory to
|
|
|
|
|
|
- Windows: cd <BenchIT-folder>\gui\bin
|
|
|
- Unix/Linux,MacOS: cd <BenchIT-folder>/gui/bin
|
|
|
|
|
|
Now run the file
|
|
|
|
|
|
- Windows: GUI.bat See GUI-errors nr. 001
|
|
|
- Unix/Linux,MacOS: ./GUI.sh
|
|
|
|
|
|
When this should contrary to expectations not start, you can try starting the file BenchIT.jar. This can be done by clicking (Windows) or running (all platforms) java -jar BenchIT.jar. Attention: If the flags, set in GUI.[sh|bat] are not set, different features won't work!
|
|
|
|
|
|
### What happens when the GUI starts
|
|
|
When the GUI starts the following things happen (not explicitly ordered):
|
|
|
- Under X/MacOS:GUI.sh
|
|
|
checking for local settings and creating LOCALDEFS for the local machine
|
|
|
- All Systems: BenchIT.jar
|
|
|
- checking for LOCALDEFS for the local machine (if not available: create a copy from PROTOTYPE)
|
|
|
- reading the file <BenchIT-mainfolder>/gui/cfg/Config.XML for LOCALDEF-descriptions
|
|
|
- reading the file <BenchIT-mainfolder>/gui/cfg/BGUI.cfg for GUI settings
|
|
|
- handling the userflags given by command
|
|
|
- starting GUI in LOCALDEF-Mode
|
|
|
|
|
|
### Environment
|
|
|
|
|
|
The BenchIT-GUI requires at least JAVA 1.4 and in some cases an additional package with aXML-Decoder. A UNIX-System is recommed, but it will also work on Windows.
|
|
|
|
|
|
Restrictions under Windows: No measuring on local system
|
|
|
|
|
|
Also it uses 128 MB of RAM, if you want to use less, change the -Xmx-Option starting script (GUI.sh/GUI.bat).
|
|
|
|
|
|
|
|
|
### Command line options
|
|
|
|
|
|
- `-host=[hostname]` for changing the name of the actually host -hostname=[hostname] the same as -host -win for setting windows look and feel (needn't to funktion well) -restart supresses the daily tip after measurement shutdown an shows result tree after restart
|
|
|
|
|
|
### First Steps
|
|
|
|
|
|
When starting the BenchIT-GUI for the first time and haven't already written your LOCALDEF-Files, some input-fields will pop-up which asks you for the basic variables.
|
|
|
|
|
|
Most of them must be filled out, but it doesn't take much time. When those questions are answered, the GUI starts.
|
|
|
|
|
|
### Features
|
|
|
- Graphical LOCALDEF-Editor
|
|
|
- Source-Code-Editor with syntax-highlighting
|
|
|
- Result Plotter with many features
|
|
|
|
|
|
### used packages
|
|
|
- jfreechart 0.9.8 http://www.jfree.org LGPL
|
|
|
- freehep http://java.freehep.org LGPL
|
|
|
- syntax.jedit.org http://syntax.jedit.org BSD-Style
|
|
|
- ant tar http://ant.apache.org/ Apache Software License Version 2.0
|
|
|
- ganymed ssh2 package http://www.ganymed.ethz.ch/ssh2 BSD-Style
|
|
|
|
|
|
|
|
|
### Building the GUI using Ant
|
|
|
Currently, there is only one Ant build script located at
|
|
|
- gui/build.xml
|
|
|
|
|
|
This Apache Ant script is used to manage the complete build process of the BenchIT-GUI. For an easier start, there is a help target, that will be executed, when no options are given to ant.
|
|
|
|
|
|
To use this script, either set up an eclipse or netbeans external tool script and configure it, or use Apache Ant from the command line.
|
|
|
|
|
|
- Navigate to the GUI's root directory gui/
|
|
|
- Issue the approriate Ant commands
|
|
|
|
|
|
Usage:
|
|
|
- `ant` will display all the targets available together with a short description.
|
|
|
- `ant clean` will erase all previous build data including the BenchIT.jar. This must be commented within build.xml to preserve the jar.
|
|
|
- `ant compile` will compile all source classes and put the class-files within build/classes .
|
|
|
- `ant pack.up` will update the BenchIT.jar with new compiled classes and new libraries from lib/ .
|
|
|
- `ant pack.noup` will regenerate the BenchIT.jar from scratch and include all jar from the lib/ directory.
|
|
|
- The three bcc.* targets are used to regenerate the Apache Axis2 client classes. Instructions for doing so can be found by calling `ant bcc.help`
|
|
|
- In order to recreate the web service client classes, a fully installed Apache Axis2 distribution is needed on the local machine.
|
|
|
|
|
|
#### Notes
|
|
|
|
|
|
The compile target is set to create Java 1.4 compatible class files, but in order to do so, Ant must be running on a Java 1.4 JDK. The easiest way is to get and unpack IBM's or Sun's JDK 1.4 and use the JAVA_HOME environment variable to call ant:
|
|
|
|
|
|
- JAVA_HOME=/usr/lib/jvm/java-1.4.2-sun ant help
|
|
|
|
|
|
In addition, you can tell ant to print out debugging informations to see which Java version will be used. `ant -d`
|
|
|
|
|
|
### Shortcuts
|
|
|
|
|
|
#### General shortcuts:
|
|
|
- F1: Help
|
|
|
- F4: Reload Kerneltree
|
|
|
- F5: Reload Resulttree
|
|
|
- <CTRL-O>: Options
|
|
|
- <CTRL-L>: switch to LOCALDEF-mode
|
|
|
- <CTRL-D>: switch to DB-mode
|
|
|
- <CTRL-E>: run selected kernels
|
|
|
- <CTRL-Q>: quit
|
|
|
|
|
|
#### Editor Shortcuts:
|
|
|
- <CTRL-F>: Find (case-sensitive search)
|
|
|
- <CTRL-G>: Go to Line
|
|
|
- When editing is available (not when analyzing a result-file)
|
|
|
- <CTRL-C>: Copy
|
|
|
- <CTRL-X>: Cut and Paste
|
|
|
- <CTRL-V>: Paste
|
|
|
- <CTRL-S>: Save
|
|
|
### GUI modes
|
|
|
|
|
|
#### Identify your current mode
|
|
|
|
|
|
Look at the Panel above the internal console (green, lower right).
|
|
|
|
|
|
- If this shows some inforamtion about architecture, environments, compilerflags,... you should be in LOCALDEF-mode.
|
|
|
- If it shows some kernel-sources, you should be in Kernel-mode
|
|
|
- If it shows a plotted result, configuration for this or a result-file as text, but also when this panel is empty, you are in Result-mode
|
|
|
- If there is no console on the lower right, you might be in DB-mode
|
|
|
|
|
|
#### LOCALDEF-mode
|
|
|
In this mode, LOCALDEFs can be edited graphically or as plain text.
|
|
|
Switch to LOCALDEF-mode by:
|
|
|
- choosing Setup->Localdefs OR
|
|
|
- typing <CTRL-L> OR
|
|
|
- pressing the button, which displays a house. (Local-defs.)
|
|
|
|
|
|
##### Additional Shortcuts
|
|
|
- <Ctrl-L>: Load the actual LOCALDEFs
|
|
|
- <Ctrl-S>: Save the actual LOCALDEFs
|
|
|
general shortcuts
|
|
|
|
|
|
##### Setting the LOCALDEFs, hints and more
|
|
|
- To change the LOCALDEFs, you can write in the text-editor or use the graphical settings. Switch between the modes with the button on the right in the toolbar.
|
|
|
- Your changes will be saved when starting a kernel locally.
|
|
|
- Your changes will NOT be saved automatically when starting a kernel REMOTE!
|
|
|
- The graphical settings will not show all information saved in the LOCALDEFs, only those which are saved in gui/cfg/Config.XML! To change the content of this file start Setup -> Localdef Specification, which will lead you there.
|
|
|
|
|
|
#### Kernel-mode
|
|
|
In this mode, you can select the kernels, you'd like to run. Also you can create new kernels or change them.
|
|
|
Switch to Kernel-mode by:
|
|
|
- pressing on the "Kernels"-tab above the tree
|
|
|
|
|
|
##### Select kernels
|
|
|
Select kernels by selecting nodes in the result-tree, which is located in the left. You can select more then one kernel by Holding <CTRL> or <SHIFT> while selecting the next one. You may also select whole groups of kernels by selecting a node, which is no leaf (E.g. select the "numerical"-node when you want to start all kernels with a numerical background (e.g. FFT, matmul, vector addition)) .
|
|
|
|
|
|
###### Last settings
|
|
|
|
|
|
When more then one kernel is selected, a combobox should appear in the top of the source editor, which lets you select the kernel which is currently edited.
|
|
|
|
|
|
! Editing other files then COMPILE.SH or PARAMETERS is only available when setting the flag kernelSourceEdit to 1
|
|
|
|
|
|
##### Starting a kernel locally
|
|
|
Start the selected kernel by ...
|
|
|
- pressing <CTRL>-E OR
|
|
|
- a right-click the kernels in result-tree and select "Execute local" OR
|
|
|
- selecting "Measure"->"Execute local"
|
|
|
|
|
|
! This should NOT work under Windows and other not POSIX-compliant OSs ! You may also stop a started local measurement, when you didn't close the GUI by selecting "Measure"->"Stop measurement"
|
|
|
|
|
|
##### Starting a kernel remote
|
|
|
|
|
|
see remote-handling
|
|
|
|
|
|
#### Result-mode
|
|
|
Switch to Result-mode by:
|
|
|
- pressing on the "Results"-tab above the tree
|
|
|
|
|
|
##### What you see
|
|
|
|
|
|
There's a tree, containing all local result-files on the left. The tree also has some nodes in the first level, which are called "Mixer". These are desribed here. On the top-right theres a panel, where you can see the result as text or as plot. Below there is the console and (if you're connected to the DB) more to add some online results to the Online-Mixer. On the right side, there's a plot or the content of a file displayed.
|
|
|
#### DB-mode
|
|
|
The DB-Mode was deactivated and integrated into the Result-Mode :) |