README

   1 FreeFOAM README for Version {fullver}
   2 =====================================
   3 Michael Wild <themiwi@users.sourceforge.net>
   4 :Author Initials: MW
   5 v{fullver}, {localdate}
   6 http://freefoam.sourceforge.net
   7
   8 Copyright
   9 ---------
  10 FreeFOAM is free software; you can redistribute it and/or modify it under the
  11 terms of the GNU General Public License as published by the Free Software
  12 Foundation; either version 2 of the License, or (at your option) any later
  13 version.  See the file COPYING in this directory, for a description of the GNU
  14 General Public License terms under which you can copy the files.
  15
  16 System requirements
  17 -------------------
  18 FreeFOAM is developed and tested on Linux, but should work with other Unix style
  19 systems, notably Mac OS X (C). The support for Microsoft Windows is a goal,
  20 which, however, is still far off.
  21
  22 Required software to build FreeFOAM
  23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 [[cmake]]CMake::
  25   In order to build FreeFOAM you need to have CMake with version 2.8.0 or
  26   newer installed. http://cmake.org
  27 [[build_system]]Build system::
  28   CMake requires a native build system. On Unix like platforms GNU Make is
  29   recommended. http://www.gnu.org/software/make
  30 [[cxx_compiler]]C++ compiler::
  31   In order to build FreeFOAM you need a C\++ compiler with good support for
  32   template expressions. The g++ compiler from GCC-4.3 and above will do
  33   fine. http://gcc.gnu.org
  34 [[flex]]flex::
  35   The flex lexer generator. Version 2.5.33 is known to work. For more recent
  36   versions there have been reports of problems. http://flex.sourceforge.net
  37 [[zlib]]zlib::
  38   zlib compression library. http://www.zlib.net
  39 [[metis]]METIS::
  40   The METIS graph partitioning library, version 5.0pre2. If your package manager
  41   doesn't contain it, you can also have FreeFOAM build it automatically for you
  42   (see the <<installation,installation section>>).
  43   http://glaros.dtc.umn.edu/gkhome/metis/metis/overview
  44 [[python]]Python::
  45   The Python interpreter. Version 2.6.1 is known to work, but care has been
  46   taken to make FreeFOAM work with versions from 2.4 on, including 3.x.
  47
  48 Optional software
  49 ~~~~~~~~~~~~~~~~~
  50 [[git]]git::
  51   To check out a current development version of FreeFOAM, git is required.
  52   http://git.or.cz
  53 [[parlib]]Parallel Communications Library::
  54   In order to run FreeFOAM in parallel, a communications library is required.
  55   The following list gives an overview of the available options:
  56   - MPI (_Message Passing Interface_): There are many implementations of the MPI
  57     standard. The one that has been tested and is known to work with FreeFOAM
  58     is http://www.open-mpi.org[OpenMPI].
  59 [[parmetis]]ParMetis::
  60   If you use an MPI library, the ParMetis library is required. If your package
  61   manager doesn't contain this library, FreeFOAM can build it automatically for
  62   you (refer to the <<installation,installation notes>> below).
  63   http://glaros.dtc.umn.edu/gkhome/metis/parmetis/overview
  64 [[mgridgen]]MGRIDGEN:: MGRIDGEN is a grid coarsening library for multi-grid
  65   solvers. FreeFOAM can build this automatically for you. Please refer to the
  66   link:INSTALL.html#enable-parmgridgen[INSTALL] file for license restrictions.
  67   http://glaros.dtc.umn.edu/gkhome/mgridgen/overview
  68 [[libccmio]]libccmio::
  69   pro-STAR (C) input/output library. FreeFOAM can build this automatically for
  70   you. Please refer to the link:INSTALL.html#enable-ccmio[INSTALL] file for
  71   license restrictions.
  72   https://wci.llnl.gov/codes/visit/3rd_party/libccmio-2.6.1.tar.gz
  73 [[paraview]]ParaView::
  74   The FreeFOAM utility 'para' requires this visualization application, version
  75   3.8 or later.  http://www.paraview.org
  76 [[m4]]M4::
  77   Some of the provided tutorial cases require the M4 macro processor.
  78   http://www.gnu.org/software/m4/
  79 [[doxygen]]Doxygen::
  80   Automatic API-documentation generator. Required to build the source
  81   documentation. http://www.doxygen.org
  82 [[asciidoc]]Asciidoc::
  83   In order to create the man-pages or the html-documentation you need to have a
  84   fully working Asciidoc toolchain installed. Versions newer than 8.5 are known
  85   to work. Asciidoc itself needs Python 2.4 or newer (but not 3.x), xsltproc,
  86   the DocBook XML DTD's and the DocBook XSL stylesheets. Refer to the Asciidoc
  87   installation instructions for the details. http://www.methods.co.nz/asciidoc
  88
  89 Installation
  90 ------------
  91 For installation and basic usage instructions, refer to the
  92 link:INSTALL.html[INSTALL] file.
  93
  94 Documentation
  95 -------------
  96 All the applications and the frequently used script utilities come with a brief
  97 man-page. Unfortunately, most of them are little more than stubs and need more
  98 work. The man-page _freefoam(1)_ gives a short overview over all applications
  99 and utilities and documents the FreeFOAM configuration options.
 100
 101 API-documentation is available from
 102 http://freefoam.sourceforge.net/doc/Doxygen/html
 103
 104 Further, most FreeFOAM applications and utilities support the '-doc' and
 105 '-srcDoc' options, which will automatically display the API-documentation and
 106 the source code of the application, respectively.
 107
 108 Help
 109 ----
 110 - http://freefoam.sourceforge.net
 111 - https://freefoam.wiki.sourceforge.net/MailingLists
 112 - http://www.cfd-online.com/Forums/openfoam/ *please only ask questions related
 113   to _OpenFOAM_ there*.
 114
 115 Reporting Bugs in FreeFOAM
 116 --------------------------
 117 http://sourceforge.net/apps/mantisbt/freefoam
 118
 119 ////////////////////////////////////////////////////////
 120 Process with: asciidoc -a toc README
 121
 122 Vim users, this is for you:
 123 vim: ft=asciidoc sw=2 expandtab fenc=utf-8
 124 ////////////////////////////////////////////////////////