--------------------------------------------------------------------------------
FoRMATo-1.1 - NLTE Model Atom Maker                    2012-10-19 Thibault Merle
--------------------------------------------------------------------------------

This  application  is designed to make  NLTE model atoms with various degrees of
complexity combining atomic databases  (VALD, KALD, NIST ASD, TOPBASE, etc.) and
sparse atomic data from the literature or semi-empirical formulae   (Seaton, Van 
Regemorter, Drawin etc. formulae) for collions with electrons and hydrogen atoms.

The DISLIN graphic library is mandatory for correct use of Formato.

A model atom is produced in ascii file in the format of the MULTI code.

Directories
-----------
atoms:  some examples of model atoms
bibli:  DISLIN graphical library  
data:   atomic data for levels, radiative bb and bf transitions
output: free directory were the model atom and plots will be set
source: fortran source code
temp:   temporary atomic data files from where the selection is done by FoRMATo


Files
-----
README:      this file
config_*.in: configuration file for a given element and ionization stage

Compile FoRMATo
---------------
In 'source' directory, edit the makefile:
 - select your favorite fortran compiler
 - set your compiler and debug options
 - choose the name of the exec file

In a shell,  'make'  command will compile, link and place the executable file in
the working directory.
'make clean' will remove the module and object files. 

WARNING: each time you want to change element or ionization degree, you have to:
 - change the name of the datagraph module,  at the very end of the fortran file 
'mdatagraph.f90',
 - check or add some specif features relative to the element for MULTI format in
 the fortran file 'mpr11_constructatom.f90'.  

FoRMATo Configuration file
--------------------------
In the working directory, the 'config_*.in' file is the configuration file where
all criteria are configurable:
 - model atom ID
 - atomic data filenames
 - criteria for energy level selection
 - criteria for radiative bb transition selection
 - criteria for radiative bf selection
 - criteria for collisional bb and bf selection
 - output options for MULTI format
 - graphical options for output plots
 - display options for running FoRMATo

FoRMATo I/O files
-----------------
TO DO

Run FoRMATo
-----------
In the working directory, the FoRMATo execution file can take  the configuration
filename as argument. Then a menu appears and you can do a sequence of:
 - 1, 2, 3, 4, 5, 6 to generate a new model atom
 - 2, 3, 4, 5, 6 to generate a model atom from the data in the 'temp' directory

Choice 7 and 8 allow you to trace Grotrian diagrams.

--------------------------------------------------------------------------------