FLARE - Field Line Analysis and Reconstruction Environment
==========================================================


Installation:
-------------

Generate a configuration file with the following command (running "./configure.sh --help" will list optional arguments):

	./configure.sh

Then compile and install the code using:

	make
	make install

The following environment variables need to be set:
        export PATH=$HOME/.local/bin:$PATH
	export PYTHONPATH=$HOME/.local/lib/python
	export LD_LIBRARY_PATH=$HOME/.local/lib:$LD_LIBRARY_PATH



Dependencies (for optional components):
-------------

-FGSL (FORTRAN interface to the GNU Scientific Library)
-GSL (GNU Scientific Library): make sure you have 'libgsl0-dev' installed as well




How to use FLARE:
-----------------

Execute "run_flare.sh" in your working directory. Required input files are:

	bfield.conf	defines the magnetic configuretion

	boundary.conf	defines the plasma boundary (divertor elements, limiters, main chamber, ...)

	run.conf	defines which sub-programs to run and allows to set input parameter




Parallelization:
----------------

Parallelization is supported for all magnetic field configurations except those based on M3D-C1 data.
Parallelization is implemented in the following tools:
-connection_length
-field_line_loss
-melnikov_function
-poincare_plot
-safety_factor
-sample_bfield
-separatrix_manifolds
-transform_to_flux_coordinates




Notes for particular architectures:
-----------------------------------
CHTC:
   -required modules:
        GCC/7.3.0-2.30
        mpi/gcc/openmpi/3.1.1-GCC-7.3.0-2.30

   -optional modules (for visualization):
        numpy-1.7.1
        matplotlib-1.3.0
        scipy-0.12.0

   -configuration (specify f2py command without Python version suffix):
        ./configure.sh f2py=f2py