==============================================================
=== Installation guide for Sonnet ============================
==============================================================
(Winfried Beer, 27-JUL-1995, Sonnet v1.01)

ABSTRACT:
    Sonnet (Self-Organizing-neural-NETwork-simulator) is a 
    simulator for self-organizing networks. This time
    SOM (Self-Organizing feature Maps, by T. Kohonen) and
    a variant, the Neural Gas (by Th. Martinetz et all) can
    be simulated. It's look&feel it~s like the simulator 
    SOM_PAK, but Sonnet have a more topologies, eg. you can
    use a three dimensional network or a ring.

PLATFORMS:
    Every computer with an ANSI-C-Compiler. But it's better
    to have an Unix-Workstation to use some shell-scripts
    for data pre- or postprocessing. If you have a X11 
    Window system, you can see the process of training net.

    Tested on Linux and Solaris 2.1.

YOU NEED:
    C-Compiler
    gnuplot (only for graphic plots)
    make, sh, awk, grep, ed, sed, gzip, tar, ...

UNPACKING:
    Sonnet is distributed as a compressed tar-file named
    "sonnet-1.01.tar.gz". For unpacking type 
        gunzip sonnet-1.01.tar.gz; tar -xvf sonnet-1.01.tar
    or
        cat sonnet-1.01.tar.gz | gunzip | tar -xvzf -

    Now you have a directory named sonnet with all
    Sourcecodes and scripts.

COMPILING:
    In directory 'sonnet' is a makefile for UNIX workstations.
    If you don't have the UNIX command "make", you must
    compile the files yourself; for dependencies see section
    FILES.
    OK, you use Unix. Edit 'sonnet/Makefile'. Insert or own
    paths for binaries and manual pages; check for compiler
    flags. After this, go into 'sonnet' and just type 
        make

    This would compile the C-sources. Normally, no error
    messages should appear.

INSTALLING:
    I think, Sonnet will not be installed in system paths
    normally. Therefore binaries and man-pages are 
    subdirectories of sonnet. If you do so, edit
    'sonnet/scripts/sonnet.sh' and 'sonnet/scripts/sonnet.csh'
    to adjust the paths to your locations. (The same like in
    your Makefile.) Otherwise, you don't have to care about 
    this files.
    To install binaries and man-pages, type
        make install

    
    After successful installation, clean up with
        make clean

    If you use bourne- or korn-shell, insert a 
        ". sonnet/bin/sonnet.sh"
    in your $HOME/.profile. If you use c-shell, insert a 
        "source sonnet/bin/sonnet.csh"
    in your $HOME/.login. These scripts insert paths to 
    binaries and man-pages in your default paths. You can 
    also just copy the few lines from these scripts.

    (These action take effect only at your next login. You
    can just type these line at your prompt to use it 
    immediately.)
    
FILES:
    sonnet/Makefile                UNIX-Makefile
    sonnet/INSTALL                 this file
    sonnet/bin/                    installation dir for bin's
    sonnet/man/                    installation dir for man's
    sonnet/examples/               example scripts
    sonnet/doc/                    manpages for programs
    sonnet/scripts/sonnet.sh       sh: setenv for sh
    sonnet/scripts/sonnet.csh      csh: setenv for csh
    sonnet/scripts/gethead         sh: get header of file
    sonnet/scripts/getraw          sh: get entries form file
    sonnet/scripts/uncomment       sh: remove comment lines
    sonnet/scripts/getminmax       sh: get min/max of entries
    sonnet/scripts/normvar         sh: standardize entries
    sonnet/scripts/norm_getval     sh: get factors for normvar
    sonnet/scripts/scale           sh: scale entries
    sonnet/scripts/scale_inv       sh: inverse scale entries
    sonnet/scripts/gp_plot         sh: gp_qerror=gp_scplot
    sonnet/scripts/gp_qerror       sh: (gnu)plot error decay
    sonnet/scripts/gp_scplot       sh: (gnu)plot scatterplot
    sonnet/scripts/gp_patch_eps    sh: improve EPS-files
    sonnet/scripts/gp_blob         sh: gp_blob_m=gp_blob_qe
    sonnet/scripts/gp_blob_m       sh: patch EPS for blobs
    sonnet/scripts/gp_blob_qe      sh: patch EPS for blobs

    sonnet/misc.c                  low level routines
    sonnet/misc.h                    header file
    sonnet/types.c                 vector and net handling
    sonnet/types.h                   header file
    sonnet/som_io.c                IO-routines for nets
    sonnet/som_io.h                  header file
    sonnet/som_net.c               algorithms for training
    sonnet/som_net.h                 header file
    sonnet/xsom_rout.c             simple X11 interface
    sonnet/xsom_rout.h               header file
    sonnet/som.h                     header for all headers

    sonnet/gendata.c               prog: create data file
    sonnet/gennet.c                prog: create net file
    sonnet/vsom.c                  prog: train net
    sonnet/xsom.c                  prog: train net with X11
    sonnet/qerror.c                prog: quantisation error
    sonnet/sominfo.c               prog: detailed statistics
    sonnet/xscplot.c               prog: plot data/net (X11)


==============================================================