Adaptive Optics Simulation Package, Version 4.3.2
-------------------------------------------------
Written by F.Rigaut. 1993-2001.
Some routines and testing provided by M.Chun

This package is written in IDL, but uses some features
of Unix (e.g. environment variable), therefore will
probably not work as such under other operating systems.


What does the package contains:
-------------------------------

By now you have "untared" simul_v4.3.2.tar

The directory simul_package contains 4 subdirectories:

- "data" contains the phase screens that are needed to generate
  turbulent phase screen in simul.pro

- "help_v3.2" contains the help files (one postscript file
and one text file, both can be brought up from the X interface).
For the files to be found by the GUI, you have to define the
unix environment variable

- "examples_v4.3.2" contains two directories, "pueo" and "12x12",
which both contain files for two sample cases.

- "v4.3.2_pros" contains the simul.pro IDL routine, together with
the common file simul.common

What to do to install simul:
----------------------------

1) Be sure that IDL is properly installed with access to the astrolib
routine library (you can get that on the web if needed).

2) Put the routine simul.pro somewhere where IDL can find it (in
the IDL path as defined by the IDL !path environment variable). 
Alternatively, you can expand the IDL !path variable to include
the new directory where simul.pro is.

3) In your .cshrc file or equivalent, set the environment variables:
	- IDL_COMMON to the directory where simul.common is 
	- IDL_SIMUL_HELP to the directory where the help files are
	e.g, in tcsh:
	setenv IDL_COMMON     /home/frigaut/idl/pro/simul_package/v4.3.2_pros/
	setenv IDL_SIMUL_HELP /home/frigaut/idl/pro/simul_package/help_v4.3/

You are done. Give it a try: go to the examples_v4.3.2/pueo directory,
enter idl, and then type
IDL> simul,/x
in the GUI, hit "Initialize" and then hit "Start loop". All the necessary
files are in this directory, this is why you don't need to recalibrate
the interaction matrix and invert it.

I advise to create new directories for each entirely new system configuration.
Copy and modify an existing ao.par when you want to simulate a new system.


There not a lot of "gard rails" in this code. It certainly is not
entirely free of bugs, and sometime the procedure to have something
done is slightly awkward. Please be a little bit patient. If you
really have to, email me at frigaut@gemini.edu and I'll try to bring
a solution to your problem. I have no time right now for upgrades
of this code.

Common mistakes:
----------------
- You change the DM configuration and forget to clear ao.mir.def_file
- The program does not find one of the files. The error message can be 
swamped into other messages. If you get an error, please always roll
up to see what the first error was, and try to solve the problem from 
there.
- The number of pixels per r0 is not large enought (>2). This will affect
performance but does not prevent the system to run.

Note: Unless you absolutely want to, I recommend you do not try to use
the "modal control" option.