Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

The YADA Reference Manual

2.0-alpha

yadalogo-white.gif
Id
yada.tcl,v 1.19 2004/02/25 14:42:10 micha Exp

Overview

YADA is Yet Another Data Analyser for the CDG parsing environment. Its purpose is to ease the task of parser evaluation by allowing the user to configure series of experiments where problem instances are computed and the resulting data is presented in a pleasent way. The data generated can be exported into an external spredsheat application or converted into raw data for gnuplot, or what ever one likes.

YADA offers a document oriented interface where documents of certain types are loadable in order to generate and display the data with them. During runtime an arbitrary number of documents is loadeable each of which can visualize different data or even the same data from a different perspectivity. Thus YADA is easily extensible by implementing new document types which the user then can instanciate. At the time of this writing the following document types are implemented:

In terms of the implementation there are more document types as can be seen in the YadaDocuments module documentation .

How to read this document

To make your way thru this reference document you might start at the modules section, i.e. YadaDocuments and the YadaScheduler . These try to divide the application into logical parts. Understanding the applications architecture might also be cleared by reading yada.tcl and YadaMain. Take a glimpse at the class hierarchy afterwards and this reference manual hopefully becomes understandeable.

Requirements

YADA is implemented in Tcl/Tk, more precisely in Itcl/Itk, the object oriented extension to Tcl/Tk (comment: no more tcl without itcl;), also using the Iwidgets set of megawidges. In addition we use the TkTable widget by Jeffrey Hobbs, and the TDom extension by Jochen Loewer. YADA is known to run with

I know there are already more recent versions of that software but, you know, never touch a running system. You might try YADA with new versions of the components. Tell me if that was successfull.

By the way, YADA is developed on linux and is not intended to run on MS Windows although TclTk is available on MS Windows. Note that I will not try to code tcl platform-independent in order to support MS Windows. YADA will be kept in a shape that it runs on unices, no MS Windows.

Environment Variables

As you might already have look at the YADA startup script yada.sh there are a few shell environment varialbes which you might be interested in:

Bug Tracking

See http://nats-wiki.informatik.uni-hamburg.de/twiki/bin/view/Papa/YadaTracking

Coding and documenting style

Ok, what's to say about coding? Most of the time too much and oneself is leaving such a guide over the time. Here are my 2cent coding style guidelines I tried to follow til now in YADA:

Hm, I'll add more if I come accross something important enuf to be mentioned here.

Copyright

Copyright (C) 1997-2004 The CDG Team <cdg@nats.informatik.uni-hamburg.de>

    YADA is licensed under the GPL.
     
    This application is free software; as a special exception the author gives
    unlimited permission to copy and/or distribute it, with or without 
    modifications, as long as this notice is preserved.
    
    This program is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
    implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
    

YADA 2.0-alpha (20 Oct 2004)