SpiderConsole/docs/INSTALL

   1 RadioConsole (Possibly referred to as SpiderConsole)
   2 by (C) 2001 Ian Norton, i.norton@lancaster.ac.uk
   3 First Release v1.0, 20010418 (18th April 2001).
   4
   5 1.  Introduction
   6
   7  This document assumes that you have the JDK or JRE already installed and
   8 working on your machine.  I have no intention of providing a HOWTO on this,
   9 there are plenty out there already. <http://www.blackdown.org> has a list of
  10 JDK/JRE mirror sites for Linux if you don't have it.
  11
  12  If you install the JRE (Java Runtime Environment) you will not be able to
  13 compile the source code, you will only be able to interpret the code that
  14 has already been compiled (Java works by compiling source into byte code,
  15 and then using an interpreter to run the byte code, this is why you must
  16 install some Java stuff, but this is also how it is platform independent).
  17  If you don't intend to modify or recompile the source code, skip the
  18 programming section, it won't be of any interest to you.
  19
  20  This version of JCAdmin has been tested with the Blackdown port for linux
  21 of the Java Development Kit version 1.3.0 <http://www.blackdown.org/>.
  22
  23 1.1.  Acknowledgements
  24
  25  Some time ago I created JCAdmin for my good friends Ian (G0VGS) and Linda
  26 (G0YLM) Maude.  JCAdmin was designed to be an admin interface to the CLX
  27 cluster software (http://www.clx.muc.de/).  It was written with the expressed
  28 purpose of performing certain tasks on Ian's cluster and never really intended
  29 to be anything marvelous.  After about a year of using this, Ian decided that
  30 CLX was no longer the software he wanted to use and switched to Dx Spider
  31 (http://www.dxcluster.org).  After much wailing and gnashing of teeth he
  32 persuaded me that perhaps I might like to write a new console for Spider.
  33 After experiencing a brief sense of flashback and "I've been here before" I
  34 decided that it would be a good challenge to write not only a new console but
  35 a framework on which to build future consoles.
  36
  37 This is the approach I have taken with this console.
  38
  39 1.2.  So how do I get this console to talk to something then?
  40
  41  The console works on the principle that whatever specific task you want to
  42 perform can be done with a plugin.  The console provides a framework for adding
  43 and removing plugins that provide menu items, toolbar buttons and so on.
  44 (Some of these features are planned but havn't yet been implemented fully).
  45
  46  To take the previously mentioned example, the SpiderCluster plugin can talk
  47 directly to the DX Spider internal protocol engine, thus allowing the user
  48 administrative rights on the cluster whilst they are using the console.
  49
  50  All sections SPECIFIC to spider are written into the SpiderCluster plugin.
  51 Generic communication modules are then used to get everything to talk.
  52 The next logical addition to the SpiderCluster plugin is a standard Cluster
  53 plugin that allows a user to connect to a spider cluster via IP (Although this
  54 requires some more work before it's actually useful).
  55
  56  So using the generic framework should make just about anything possible.
  57 Want a graph of WWV/WCY?  Just write a new plugin for it then!
  58
  59 1.3.  Getting it to run.
  60
  61  Compile all the java files in the src directory simply with javac *.java.
  62  You should now be able to start the console with java Console.
  63  By default the SpiderCluster plugin is used and a connect made to
  64         127.0.0.1:27754.
  65
  66 1.4.  New versions / updates.
  67
  68  New versions of RadioConsole and it's documentation will be made available
  69  through the DX Spider homepage <http://www.dxcluster.org/>.
  70
  71 1.5.  Feedback
  72
  73  Please mail me your comments, observations and suggestions for features or
  74 improvements and in the unlikely event (!) of bugs.  I will do my best to give
  75 you a prompt reply and request number!
  76
  77 Ian Norton
  78
  79 i.norton@lancaster.ac.uk