##########################################################################
#   Readme file for ParselTongue/Python scripts for EAVN data analysis   #
#                           ReadMe_pipelines.txt                         #
#                     2018 September 17   Hiroshi Imai                   #
##########################################################################

# Guide for the pipeline scripts

1. Start with reading this Readme file to check which scripts are currently available.
2. It is strongly recommended to update your scripts regularly 
   (for better performance with bugs fixed and/or new functionality).
3. It is strongly recommended to save the input files used for your individual processings. 
4. If any problem, please contact to H. Imai (k3830453@kadai.jp) for quick recoverty and maintenance. 

# Running the pipeline scripts

a) Available main routine Python scripts:
  EAVN.py:    Calibration and continuum source imaging for VLBI data provided in a form of FITS-IDI 
            handled in the classic AIPS. Some special fuctions dependenrt on the specified array 
            (such as VERA, KVN) are operated.
  velocity_track.py:  Velocity deffinition (SETJY) and velocity tracking (CVEL)
  MCAL.py:    Calibration using maser lines. For VERA, the inverse phase-phase-reference procedures 
            are applied.
  MMAP.py:   Synthesis of maser image cubes, including functions of wide-field mapping and automatic 
            CLEAN box setting.

  KaVA_ingest.py:   Ingest pipeline for KaVA/EAVN ESTEMA projects, splitting a single FITS data into 
                  subsets of data corresponding to specific missions.
  KaVA_merge.py:   Merge of KaVA (KVN and VERA Array) and KVN data with different numbers of the array 
                 telescopes.
  MSHAPE.py:  Statistical extraction of maser spot shapes with Gaussian fitting (now in construction).

b) How to run the script
 b.0)  Install ParselTongue in your computer, of course. 
     It is also recommended to set some environment variable in your login setup, such as:
       "setenv PT /xxx/yyy/zzz/ParselTongue" in .tcshrc in your home directory.
 b.1)  Edit the associated input file (*.inp) corresponding to the main routine. 
     The meanings of the individual adverbs are described in the input file. 
     Therefore, the input file shall provide the manual of the main routine. 
     It is strongly recommended to change the input file name to give some record of your 
     observation sessions, trials, etc. to yield the database. 
 b.2)  Prepare for the directory for FITS files, input files, and output files. 
 b.3)  Type as follows. 
      << ParselTongue execution file name >> << main routine Python script name >> << input file for the routine >>

# Latest version of the scripts and input files are availavble as follows.
   See: ParselTongue_Package.tgz in: 
   https://mwg.sci.kagoshima-u.ac.jp/wiki/pages/v3m7U6P5/Data_Analysis__Image_Processing.html

   Note: Updating the script and input files will be made without any public annoucement.
         The update log will be updated simultaneously and appear in the same wiki page. 

