#==============================================================
#
#  Name: README
#
#  Rem:  The files in this directory contains common database
#        and templates for the EPICS Magnet Application.
#
#  CVS Loc:  epics/ioc/Magnet/mgntApp/Db/common
#
#  Auth: 04-Apr-2010, K. Luchini      (LUCHINI)
#  Rev:  dd-mmm-yyyy, Reviewer's Name (USERNAME)
#
#==============================================================
#
The following list of databases are included within the magnet device
databases, which are catagorized by power supply type. These database
are included by virtue of instantiating a magnet via a magnet device database.

Filename                             Description
----------                           -----------------
README                               This file
mgnt_calb.template                   Calibration control function template
mgnt_fbck.template	             Magnet feedback control
mgnt_hsta.template                   Magnet device hardware status template
mgnt_phy.template                    Magnet device physical control (BDES,etc) template
mgnt_raw.template                    Magnet device raw control (IDES,etc) template
mgnt_model.template                  Magnet model PVs (ECON,EACT,EDES)
mgnt_stat.template                   Magnet device Status template
mgnt_stdz.template                   Standardize control function template
mgnt_tol.template                    Magnet B-field and Current tolerances template
mgnt_trim.template                   Trim control function template
mgnt_degauss.template                Degauss control function template
mgnt_diag.template                   Debug PVs

The following database are used to instantiate polynomial coefficients.
There shold be one entry per magnet. The pulsed magnet requires an exta entry
to covert current to voltage output. 

Filename                             Description
----------                           -----------------
mgnt_poly.template                   Magnet Polynomial template for B-to-I conversion
mgnt_poly_kick.template              Magnet Polynomial template for I-to-V conversion

# Magnet devices databases. 
When adding a magnet, determine the type of power supply used to power the magnet
and choose the appropriate magnet device database to instantiate the magnet. If the
magnet is configured as a string, then instantiate the slaves using mgnt_string_slave_notrims.db
for slaves without trim coils or mgnt_string_slave.db for a slave magnet with trim coils.

Filename                             Description
----------                           -----------------
mgnt_intermediate.substitutions
mgnt_kick.substitutions
mgnt_lgps.substitutions
mgnt_smps.substitutions
mgnt_string_slave_notrims.substitutions
mgnt_string_slave.substitutions

The following datases are used for special magnet configurations, which usualy 
involves a magnet string. The magnet database is designed such that all magnets
include the same set of EPICS PVs, so that high level applications accessing 
magnet information, does not have to contain special code to determine if an
EPICS PV will exist for that magnet. However, there are a few exceptions to this
rule with regard to magnet strings.

Filename                             Description
----------                           ----------------
mgnt_string_ctrl.template            Magnet string device control template
mgnt_string_status.template          Magnet string devices status template

# End of file

