BOCCIO@SWAT.SWARTHMORE.EDU (John) (09/25/90)
========================================================================
README file for Computational Physics Project software
------------------------------------------------
v1.0, 8/13/90, Copyright (C) 1990 Eric Stollnitz
Swarthmore College Computational Physics Project
------------------------------------------------
Distribution, modification, and re-use are permitted only in
accordance with the copying policy stated in the README file
========================================================================
Overview
========
The source code in this distribution is under development as a
computational physics project at Swarthmore College in Pennsylvania. It
is being distributed (with some restrictions) as version 1.0 so that
others can make use of the library and programs, and so that we can make
improvements based on comments and bug reports. The DECwindows variant
of the X Window System is required to compile the source code. The
software should compile correctly on any VAX (under VMS or Ultrix) and
any RISC/Ultrix machine. This distribution includes:
MAKE.COM a VMS command file to compile all source code in the
distribution
Make.script a Unix shell script to compile all source code
app_lib/ a library of two- and three-dimensional graphics routines,
as well as simplified programmer interfaces to DECwindows
menu, dialog box, and file selection widgets
doc/ documentation for all source code
examples/ example programs which make use of the application library
and the utility programs
hdf/ a subset of the National Center for Supercomputing
Application's HDF (hierarchical data format) library, used
by the utility programs for data storage and retrieval
include/ include files for the application library and utilities
utils/ four utilities for displaying scientific data (two- and
three-dimensional line graphs, image manipulation, and
three-dimensional surface viewing), and an X Window to
PostScript conversion program
Obtaining the software
======================
The current version of this software is available for anonymous
ftp from chaos.swarthmore.edu (130.58.65.3). The source code is located
in the pub/comp_phys directory structure. It is also archived in the
file comp_phys.tar in the pub directory. Ultrix users can extract the
entire source code directory structure by typing tar xvf comp_phys.tar.
VMS users should ftp the tar2vms program (in directory pub/tar2vms); the
comp_phys directory structure can be extracted by typing:
DEFINE TAPE COMP_PHYS.TAR
TAR2VMS :== $ DEV:[DIR]TAR2VMS
TAR2VMS XV
where DEV and DIR specify the location of TAR2VMS.EXE. The fixatr
program provided by NCSA (to fix up HDF files on VMS systems) is located
in pub/fixatr. See the file README.VMS for more information.
For those who are not interested in the source code or
documentation, executables for RISC-based and VMS machines are located
in the RISC and VMS directories, respectively.
Compiling
=========
To create the complete package under Ultrix, first check the
Makefiles in each subdirectory to make sure directories are specified
correctly. Then simply type Make.script in the top directory. For VMS
systems, be sure the MAKE.COM and MAKE.OPT files specify directories and
link libraries correctly. Then, in the top directory, type @MAKE to
compile everything. See the individual documentation files for further
information.
Running
=======
To be able to run any of the programs using Ultrix, edit your
.login file to include the utils and examples directories in your path.
After you log in, you should be able to run any of the programs simply
by typing its name followed by any arguments.
VMS users can use the RUN command to execute any of the
programs. In order to use command-line arguments, however, it is
necessary to define command verbs for each program. If you edit the
NAMES.COM file to use the correct top-level directory and then type
@NAMES, the verbs will be defined automatically.
Copying policy
==============
Except for the source code in the HDF subdirectory, all files in
this distribution are Copyright (C) 1990 Eric Stollnitz, Swarthmore
College Computational Physics Project. The C routines and header files
in the HDF subdirectory were developed by the National Center for
Supercomputing Applications (NCSA) at the University of Illinois at
Urbana-Champaign, and have been placed in the public domain. You are
hereby granted the right to copy and distribute (on a non-profit basis)
this version of the Computational Physics Project software, as source
code, object files, or executable programs. You also have the right to
modify the programs and use parts of the source code in your own programs.
However, you may not distribute any such modified or derived works
without the permission of the original author. Changes that could be
useful to others should be sent to the author for inclusion in future
versions (see below).
Bugs, suggestions, comments, and questions
==========================================
Suggestions, comments, or questions on any of the included
software are welcome. Some improvements are already being planned;
they are listed in the TODO file in this directory. Reports of bugs
should include the type of machine you are using and your operating
system, as well as a description of the problem--the more specific you
are, the more helpful it will be. Please send messages about this
package to Eric Stollnitz at:
ejs92@campus.swarthmore.edu
or
ejs92@swarthmr.bitnet
or
Swarthmore College
500 College Avenue
Swarthmore, PA 19081
For more information about the Swarthmore College Computational
Physics Project, contact Professor John Boccio at:
boccio@campus.swarthmore.edu
or
boccio@swarthmr.bitnet
or
Department of Physics and Astronomy
Swarthmore College
500 College Avenue
Swarthmore, PA 19081