EKS Installation Instructions

The EKS system was developed in the late 80's as a
means to construct alternative approaches to building
energy modelling within a single environment. The
approach taken is summarised in publications downloadable
from www.esru.strath.ac.uk/publications.htm while specific
documentation is available as described below. Please
note that the EKS system is not presently supported by ESRU.

The EKS download is contained in the file EKS.tar.gz.  When
uncompressed and tar extracted, the EKS environment will
have been created.

EKS has been compiled for the following environment:
Sun 4 Workstation - minimum 8MB RAM, monochrome monitor,
SunOS 4.1 (or later), X Windows (Version 11 Release 5),
and standard Fortran and C compilers/libraries.

The following shared libraries are required for run-time
linking:

        -lX11.4 => /usr/lib/X11/libX11.so.4.10
        -lF77.1 => /usr/lang/libF77.so.1.1
        -lc.1 => /usr/lib/libc.so.1.6

Define the LD_LIBRARY_PATH environment variable for other
locations of these libraries.

This EKS distribution has a number of programs and
libraries used to create, build and run models:

+ the programs are held in ~eks/bin;
+ supplementary tools, 3rd party software etc is held
  or referenced in ~eks/sys/bin; and
+ the libraries (EKS class and intrinsic) are held
  in ~/eks/lib.   

These programs and libraries are all that is required
to use the EKS.

Specific EKS documentation is held in held in ~eks/doc,
while the manual pages for each class are held
in ~/eks/classes/man. As well as the documentation,
there is a number of tutorials showing how to use the
system. These are held in ~eks/demo.

The program and library contents (source code)
are held in ~/eks/classes.  The taxonomy diagram
of demo/d0 shows the "principal" EKS classes, ie
those classes  selected by the EKS user to build
the required model.  All other classes are "intrinsic".

Each principal class (box on the taxonomy diagram) has:

+ An abstract class defining its class interface,
  ie what functionality it provides and what other
  classes it interacts with.  These are derived from
  the EKS root class "EKSObject".  These abstract
  classes are held in ~eks/classes/base/...

+ One (or more) class(es) providing (alternate variants
  of) this functionality.  These are derived from the
  abstract class and are held in ~eks/classes/principal/...

In addition to the principal classes, the EKS makes use
of several other class types.  These intrinsic classes
(ie not requiring specific selection by the template
builder) comprise:

+ Infrastructure classes, ie those classes that provide
  the underlying EKS functionality - eg the Template,
  Metaclass and EKSObject classes.  These come in two
  variants, standalone and ONTOS-based.  These classes
  live in two subdirectories "solo" and "oodb" under
  ~eks/classes/intrinsic/infrastructure.

+ Dimension classes, ie those classes providing the
  dimension type checking as carried out by the principal
  classes.  These classes live in ~eks/classes/intrinsic/dimension.

+ Transport classes, ie classes used to package information
  being passed between principal classes.  These classes
  live in ~eks/classes/intrinsic/transport.

+ Data classes, ie those classes containing standard data,
  usually installed in the database - eg ClimateSet,
  Substance and Finish.  They generally have associated
  datafiles, eg the actual climatic parameters, used in
  creating the instances.  These classes live in
  ~eks/classes/intrinsic/std_data.

Finally, there is an install directory, ~eks/classes/install
containing the "makefile" for regenerating the eks programs
and libraries. The EKS was developed under Unix utilising
Sun Workstations and related software technologies.
