                     BRUCE v2.71

Please read *ALL* of this file before doing anything!

1) Legal stuff

    Bruce v2.71 Non-Radial Pulsation Code - Richard Townsend
    Copyright (C) 1997 Richard Townsend

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; see the file COPYING.  If not, write to
    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
    Boston, MA 02111-1307, USA.

2) Description

    Bruce is a FORTRAN program which models non-radial pulsation in
    rotating stars. For a complete description of the program, see
    "Spectroscopic modelling of non-radial pulsation in rotating early-type
    stars" - Townsend R H D, 1997, MNRAS 284, 139. An even fuller
    description can be found in "Non-radial pulsation in early-type
    stars" - Townsend R H D, 1997, PhD Thesis, University of London.
    This thesis may be downloaded via anonymous ftp from

      ftp://ftp.star.ucl.ac.uk/pub/rhdt/thesis.ps

3) Manifest
 
    Files in the top-level directory:

      ./README   - this file
      ./COPYING  - legal copying info (the GPL)
      ./CHANGES  - release & update info
      ./Makefile - standard makefile for building the executables

    The main distribution comes in three subdirectories:
      
      ./bruce/*  - source files for bruce
      ./lsdlib/* - source files for the LSD library, used by bruce
      ./kylie/*  - source files for kylie, fkylie and gkylie

    Kylie/fkylie/gkylie do not really form part of the distribution, but are
    included to illustrate typical methods of using "dump files" produced
    by bruce. It is anticipated that authors will integrate kylie with
    their own spectral synthesis routines (parts which need modification
    for such an integration are marked with MODIFY: comments in the code).
    Once you have your "integrated" version of kylie, edit ./kylie/Makefile
    as is needed, and add "kylie" to the SUBDIRS definition in ./Makefile.
    Note that kylie/fkylie/gkylie are all covered by the GPL.

4) Installation

    To compile bruce, edit the Makefile so that compilation flags 
    suitable for your computer and FORTRAN compiler are set.
    Then type "make" to compile. All of the source will (hopefully) 
    compile to produce the executable "bruce" in the ./bruce/ subdirectory.
    Of course, this assumes you have the make utility!

5) Running bruce

    To run bruce, place the executable in your exec path, and just type

      bruce < command_file

    where command_file is a command file compliant with the syntax described
    in the author's PhD thesis (see above). Happy modelling!

6) Documentation

    The source code for bruce is extensively commented. Documentation
    on the physics behind bruce, and the command file syntax, can be
    found in the author's PhD thesis (see above). IMPORTANT - Please also
    read the CHANGES file, since this will contain updates to the documentation
    which reflect modifications to bruce.

7) Support
     
    In September 1997, the author is departing to Ghana for two years, and
    therefore will not be able to provide support (bug reports etc) for 
    bruce easily. In his absence, bruce is being maintained by Prof Ian
    Howarth, who can be contacted via email at idh@star.ucl.ac.uk. Please
    send any bug reports etc to this address, clearly marked with 
    "BRUCE SUPPORT". However, there is no guarantee that any support 
    requests will be honoured. Any updates to bruce may be found at
    the distribution ftp site:

      ftp://ftp.star.ucl.ac.uk/pub/rhdt/bruce-2.71.tar.gz    

    These updates will be noted in the CHANGES file. If you wish to
    be notified of new releases of bruce, please inform Prof Howarth
    that you are in possession of a copy of bruce, so that your name
    can be added to the user's list.

    If you have real problems, or want to make comments on the code,
    feel free to write to the author at:

       Dr Richard Townsend
       Tuna STS
       PO Box 46
       Bole 
       Northern Region
       Ghana
       Africa

    Since the postal turnaround rate in Ghana is slow, do not expect 
    immediate replies, but your correspondence will be answered!

8) Acknowledgement

    Any published scientific work which uses bruce, or is based upon
    bruce, should acknowledge both bruce and its author, Richard Townsend,
    at some point in the publication (go on, put me on the author list!).


    

