FD4: Four-Dimensional Distributed Dynamic Data structures

Copyright 2010-2016 Matthias Lieber, ZIH, TU Dresden, Germany
matthias.lieber@tu-dresden.de


== Prerequisites ==

Compiling and running FD4 requires:
* Unix or Linux sytem
* GNU make
* C and Fortran 95 compilers
* An MPI-2 implementation (like Open MPI or MPICH2)
FD4 has been tested with the following compilers: GCC/GNU Fortran, GCC/G95,
Intel, IBM, PathScale, PGI, Solaris Studio, GCC/NAG.

Optional features of FD4 require additional external packages:
* The NetCDF library is required for NetCDF output.
  Parallel output is available with NetCDF4 only (if compiled with parallel HDF5).
  Serial output is possible with both NetCDF3 and NetCDF4.
  Note, that NetCDF output is currently not optimzed in FD4.
  Website: http://www.unidata.ucar.edu/software/netcdf/
* Compiled sources of Vis5D+ are required to write output to Vis5D files.
  Website: http://vis5d.sourceforge.net
* ParMETIS is required for graph-based dynamic load balancing.
  Website: http://glaros.dtc.umn.edu/gkhome/metis/parmetis/overview/

== Configuration ==

* Create a configuration file for your system in the directory config/.
* You can use conf.default as a starting point or the other config files
  specific to some compilers.
* Name the config file conf.<NAME> or just overwrite conf.default.
* Optionally edit config/fd4flags.in to set some configuration flags for FD4,
  most notably FD4_VERBOSE_LEVEL (level 3 enables expensive runtime checks and
  has performance impact!).

== Compiling FD4 ==

* Type 'make conf=<NAME>' (in this directory).
  * You need GNU make; this may require calling 'gmake' instead of 'make'
    on certain systems.
  * If you name your config file conf.default, you can just type 'make'.
* You can use parallel make to speed up the build process by calling, e.g.,
  'make -j 4 conf=<NAME>'.
* This should build the library libfd4.a.
* To create multiple builds of FD4, use './mkbuilddir.sh <DIR>' to create a new
  build directory (with its own configuration) and call make from there.

== Documentation ==

* The manual/ directory contains the user guide.
* The doc/index.html contains documentation of the framework's subroutines.
* The file ChangeLog.txt contains the history of changes in FD4.

== Tutorial ==

* The tutorial/ directory contains a collection of simple demo programs.
* If you were successful in building the FD4 library, type 'make conf=<NAME>'
  in the tutorial/ directory.
* Run with 'mpirun -np <NPROCS> ./<PROG>' (or whatever method is required
  to start MPI parallel programs on your system).

== License ==

FD4 is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

FD4 is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with FD4.  If not, see <http://www.gnu.org/licenses/>.
