### $Id$ ###
*********************************************************
***** TASK : Transport Analyzing System for tokamaK *****
*********************************************************

System Requirements:
       UNIX or UNIX-like system (including Linux, MacOSX)
       Fortran95 compiler with extention (gfortran, pgf95, ifort, ...)
       X-Window library
       GSAF graphic library
          distributed with TASK
          http://p-grp.nucleng.kyoto-u.ac.jp/~fukuyama/gsaf/

Optional Libraries:
          Lapack    Linear algebra library 
                        http://www.netlib.org/
          MPI       Parallel processing library
                        for example, MPICH implementation
                        http://www-unix.mcs.anl.gov/mpi/mpich/
          MDSplus   Scientific data base library
                        http://www.mdsplus.org/
          PETSc     Paralle Matrix library
                        http://www.mcs.anl.gov/petsc/

Present modules: (*: under development)
    plx:   Module interface library
    eq:    2D equilibrium module (fixed boundary)
    equ:   2D equilibrium module (free boundary)
    tr:    1D transport module (diffusive transport)
    trn:   1D transport module (diffusive transport, new version)
    tx:    1D transport module (dynamic transport)
    txm:   1D transport module (dynamic transport, multi-species)*
    fp:    3D Fokker Planck module (PETSc, MPI)
    dp:    Wave dispersion module
    wr:    3D ray tracing module
    w1:    1D full wave module (FDM, MLM)
    wm:    3D full wave module (FFT/FDM)
    wmf:   3D full wave module (FFT/FEM)
    wf2:   2D full wave module (FEM)
    wf3:   3D full wave module (FEM)
    wf2d:  2D full wave module (FEM, MUMPS, MPI)
    wf3d:  3D full wave module (FEM, MUMPS, MPI)
    fit3d: NBI module
    tot:   all-in-one program (eq, tr, fp, wr, wm)
    lib:   common libraries
    mtxp:  parallel matrix libraries
    tools: various tools to handle ufile

To be removed near future
    pl:    Module interface library (old verson)
    mtx:   matrix libraries
    mtxpc: parallel complex matrix libraries
    mpi: interface 

Install: 
    0: Install GSAF graphic library, Before installing TASK
          tar xvzf gsaf-yyyymmdd.tar.gz
	  cd gsaf/sc
	  cp ../arch/XXXXXXX/Makefile.arch
	  make
	  make install
    1: Expand tar.gz file
          tar xvzf task-yyyymmdd.tar.gz
          tar xvzf bpsd-yyyymmdd.tar.gz
    2: Move to task directory
          cd task
    3: Create make.header
          cp make.header.org make.header
    4: Edit make.header
          Remove "#" of the first column of appropiate section
          Set the location of graphic libraries.
          If you have Lapack library, change "#"s.
          If you have MDSplus library, change "#"s.
    5: Make common library
          cd lib
          make
          cd ..
    6: Make bpsd library
          cd ../bpsd
          make
          cd ../task
    7: Make appropriate module
          cd tot [for example]
          make
          ./tot [for example]

Update:
    If you change a source file in the present module, 
        "make" again.
    If you change a source file in the other module, 
        you need to "make libs"
    If you change settings in a Makefile or make.header, 
        you need to "make clean" and "make" again.

Standard input command:
    V: view input parameters
    R: run the calculation
    C: continue the calculation
    G: graphic mode
         commands in graphic mode (see documents of the module)
         X: exit graphic command
    S: save present calculation data
    L: load saved calculation data
    Q: quit execution

Input parameters:
    1. Definitions and default values of input parameters are
       described in XXinit.f.  Most of common input parameters 
       are given in plx/plinit.f.  We do not recommend you to 
       modify XXinit.f.  You had better to use XXparm file 
       described in the next item instead.
    2. You can set standard input parameters in a text file 
       XXparm located at the working directory.  The format
       of XXparm file is the fortran namelist input.
    3. You can change the input parameters on the input command 
       line.  A input line including a character "=", e.g. 
       "RR=6.2", is recognized as a part of namelist input.

Compile parameters:
       The size of arrays are usually defined in XXcom0.inc.
       For large scale calculation, you may need to increase 
       the numbers in XXcom0.inc and "make" again.

Agreement: 

TASK code was originally developed by A. Fukuyama, Department of
Nuclear Engineering, Graduate School of Engineering, Kyoto University.

Users of TASK codes and modules must acknowledge the TASK system and
any modifications made when publishing or presenting results.  If you
use the transport models, NCLASS, GLF23, IFS/PPPL, you must ackowledge
also NTCC.

The following components may be copyrighted by the original authors.

  *NCLASS:   Neoclassical transport model
             W.A. Houlberg (ORNL)           imported from NTCC
  *GLF23:    Turbulent transport model
             J.E. Kinsey (Lehigh U) et al.  imported from NTCC
  *IFS/PPPL: Turbulent transport model
             A.J. Redd (Lehigh U) et al.    imported from NTCC
  *CYTRAN:   Cyclotron radiation 
             W.A. Houlberg (ORNL)           imported from NTCC
      NTCC: National Transport Code Collaboration
            http://w3.pppl.gov/ntcc/
            see agreement: http://w3.pppl.gov/ntcc/downloads.html

  *Weiland:  Turbulent transport model
             J. Weiland (Chermers U)        by courtesy of the author

   DSPFNV:   Plasma dispersion function
             T. Watanabe (NIFS)             by courtesy of the author

   FFT:      Fast Fourier transform
             T. Ooura (Kyoto U)
             http://www.kurims.kyoto-u.ac.jp/~ooura/fft.html

   Bessel functions:    netlib
   Gamma functions:     netlib
   Error functions:     netlib
   Brent method:        netlib
   BSTAB matrix solver: netlib
             netlib: http://www.netlib.org/

Acknowledgments: 

   Part of the TASK system has been developed, updated and maintained
   by the graduate and under-graduate students in Department of
   Electrical and Electronic Engineering, Okayama University, and
   Department of Nuclear Engineering, Kyoto University.  Many
   comments, questions and informations from the users of TASK system
   have been greatly appreciated.  The development of TASK system is a part
   of activities of Burning Plasma Simulation Initiative (BPSI:
   http://bpsi.nucleng.kyoto-u.ac.jp/bpsi/).  

Licensing notification: 

Permission to use, reproduce, prepare derivative works, and to
redistribute to others this software, derivatives of this software,
and future versions of this software as well as its documentation is
hereby granted, provided that this notice is retained thereon and on
all copies or modifications. This permission is perpetual, world-wide,
and provided on a royalty-free basis. Kyoto University and all other
contributors make no representations as to the suitability and
operability of this software for any purpose. It is provided "as is"
without express or implied warranty.

Portions of this software are copyright by Kyoto University.

This license DOES NOT apply to the above-indicated components
copyrighted by the original authors.  Each of those components are
covered by their own copyrights and licenses.


UPDATE:

The newest version of TASK system is available from
        http://bpsi.nucleng.kyoto-u.ac.jp/task/

Your comments as well as bug information on TASK system should be mailed to
	fukuyama@nucleng.kyoto-u.ac.jp

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