
                                     Kalypso
                              Version 1.01 (April 2002)

WHAT IT DOES

Kalypso is a tool for researchers involved with the physics of atomic
collisions in metals. Kalypso models such collisions using a
molecular dynamics method which represents atomic interactions as
many-body Sutton-Chen or Tight-Binding potentials.

The package is best suited for simulations of processes arising from
single projectile collisions with a target lattice. For example, 
sputtering of the target, or projectile reflection, implantation or
adsorption. Various other 'experiments' can in principle be
simulated (for example, diffusion), but these are not documented
or supported by the author. (The reason for this will be obvious
when you see the volume of documentation already required for the 
package.)

There are many references in the documentation to the Simulation
Kit (and Snook, its simulation engine). Version 2.4 of the
Simulation Kit - the final public version - will be released in 
the next year or so, but it will have few, if any, new features. 
The release will simply fix some quirks and tidy up the 
documentation.

WHAT IT DOES NOT DO

Kalypso is not suitable for simulations of semiconductors.

INSTALLATION

Unzip files, making sure that the directory structure is maintained
(not essential, but makes files easier to find). No further
installation is required. To remove files, delete the directory
tree in which the package files are stored. Kalypso does not
modify your Windows registry or system files.

PLATFORMS

Windows 95 etc.: Yes
Windows NT4: Yes
Win 3.1 with Win 32s: No
Linux: No, but coming one day, I hope

TERMS OF DISTRIBUTION

Kalypso is released into the public domain by the author. That means you can
copy and distribute these programs as you see fit.

SOURCE CODE

The source code will not be released into the public domain in the
foreseeable future.

SUPPORT

I will endeavour to support the package via e-mail (see below) during 2001.
Check my web page (see below) for any updates to the docs or binaries.
The programs have run well for the last two years, so I don't
anticipate any major problems. Don't contact me if you have not made a
serious attempt to read the documentation.

BUGS AND ERRORS

Kalypso does not crash, except because of power surges. If
the timestep is too large you may get an error message which
wrongly attributes blame to the 'Number of Partners' parameter.
If an input file is corrupt you might have to restart Kalypso
(or any of the programs).

Spider sometimes gives an error message on shutdown if MS
Word is running. This seems to originate in the richedit
system file used by Windows, but I haven't tried to
fix it.

If you notice any errors in the documentation please let me know. 
Users should, of course, take responsibility for double-checking 
input data before running serious simulations.

MAIN CONTENTS

- The executable files (SPIDER, KALYPSO, WINNOW) of the package are
located in the BIN directory (as is the CONE utility). 

- Various documents and manuals are found in the DOCS directory.

- Input data for the example simulation projects are found under the EXAMPLES 
directory.

- A tutorial project (with documentation) is found in the TUTORIAL directory.

GETTING STARTED

(1) For quick overview, look at the files Spider UI.PDF, Kalypso UI.PDF and
Winnow UI.PDF (in the DOCS directory).

(2) Read TUTORIAL.PDF, then work through the tutorial.

(3) Read SIMULATION PRIMER.PDF, and USER GUIDE.PDF, and try to run the example 
projects.

Users risk frustration if they try to apply zero experience of simulation 
to research-level simulation problems. It is better to approach your objective 
slowly, making sure you understand the fundamentals.

As always, many thanks to those correspondents who offered suggestions,
sent reprints, and/or answered my e-mail questions.

Good luck with the package.

Marcus Karolewski

University of Alberta

e-mail (a) mkarol@ualberta.ca
e-mail (b) karolewski@alum.mit.edu [if no reply from (a)]

http://www.ualberta.ca/~mkarol

London-Singapore-Edmonton
1993-2002
