                     BRUCE v2.8

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

1) Legal stuff

    Bruce v2.8 Non-Radial Pulsation Code - Richard Townsend
    Copyright (C) 1997,1998,1999,2000 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 on the web from:

      http://www.star.ucl.ac.uk/~rhdt/download/thesis.ps.gz

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

    Kylie does not really form part of the distribution, but is
    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 is covered by the GPL.

4) Installation

    To compile bruce, edit ./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 & CHANGES notes (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

    This "product" is now supported - sort of! Any problems, drop the
    author an email at rhdt@star.ucl.ac.uk.

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!).

9) Updates

    You should look (as frequently as possible) at the bruce website:

      http://www.star.ucl.ac.uk/~rhdt/download/

    This will contain updates/bugfixes to the program, as and when they
    become available.

10) User-list

    If you are an active user of bruce, drop me an email at rhdt@star.ucl.ac.uk,
    so that I can keep an up-to-date list of users. This will enable me to
    inform people when significant updates or bugfixes are implemented.
