| blob | b1f795e93fba55e4be448c8c5a4bc1b75556616c |
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
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.
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.
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 [[scotch]]SCOTCH::
40 The SCOTCH graph partitioning library. Version 5.1.7 is know to work.
41 http://www.labri.fr/perso/pelegrin/scotch
42 [[python]]Python::
43 The Python interpreter. Version 2.6.1 is known to work, but care has been
44 taken to make FreeFOAM work with versions from 2.4 on, including 3.x.
46 Optional software
47 ~~~~~~~~~~~~~~~~~
48 [[git]]git::
49 To check out a current development version of FreeFOAM, git is required.
50 http://git.or.cz
51 [[parlib]]Parallel Communications Library::
52 In order to run FreeFOAM in parallel, a communications library is required.
53 The following list gives an overview of the available options:
54 - MPI (_Message Passing Interface_): There are many implementations of the MPI
55 standard. The one that has been tested and is known to work with FreeFOAM
56 is http://www.open-mpi.org[OpenMPI].
57 [[metis]]METIS::
58 The METIS graph partitioning library, version 5.0pre2. If your package manager
59 doesn't contain it, you can also have FreeFOAM build it automatically for you
60 (see the <<installation,installation section>>).
61 http://glaros.dtc.umn.edu/gkhome/metis/metis/overview
62 [[parmetis]]ParMetis::
63 If you use an MPI library, the ParMetis library is required. If your package
64 manager doesn't contain this library, FreeFOAM can build it automatically for
65 you (refer to the <<installation,installation notes>> below).
66 http://glaros.dtc.umn.edu/gkhome/metis/parmetis/overview
67 [[mgridgen]]MGRIDGEN:: MGRIDGEN is a grid coarsening library for multi-grid
68 solvers. FreeFOAM can build this automatically for you. Please refer to the
69 link:INSTALL.html#enable-parmgridgen[INSTALL] file for license restrictions.
70 http://glaros.dtc.umn.edu/gkhome/mgridgen/overview
71 [[libccmio]]libccmio::
72 pro-STAR (C) input/output library. FreeFOAM can build this automatically for
73 you. Please refer to the link:INSTALL.html#enable-ccmio[INSTALL] file for
74 license restrictions.
75 https://wci.llnl.gov/codes/visit/3rd_party/libccmio-2.6.1.tar.gz
76 [[paraview]]ParaView::
77 The FreeFOAM utility 'para' requires this visualization application, version
78 3.8 or later. http://www.paraview.org
79 [[m4]]M4::
80 Some of the provided tutorial cases require the M4 macro processor.
81 http://www.gnu.org/software/m4/
82 [[doxygen]]Doxygen::
83 Automatic API-documentation generator. Required to build the source
84 documentation. http://www.doxygen.org
85 [[asciidoc]]Asciidoc::
86 In order to create the man-pages or the html-documentation you need to have a
87 fully working Asciidoc toolchain installed. Versions newer than 8.5 are known
88 to work. Asciidoc itself needs Python 2.4 or newer (but not 3.x), xsltproc,
89 the DocBook XML DTD's and the DocBook XSL stylesheets. Refer to the Asciidoc
90 installation instructions for the details. http://www.methods.co.nz/asciidoc
92 [[installation]]
93 Installation
94 ------------
95 For installation and basic usage instructions, refer to the
96 link:INSTALL.html[INSTALL] file.
98 Documentation
99 -------------
100 All the applications and the frequently used script utilities come with a brief
101 man-page. Unfortunately, most of them are little more than stubs and need more
102 work. The man-page _freefoam(1)_ gives a short overview over all applications
103 and utilities and documents the FreeFOAM configuration options.
105 API-documentation is available from
106 http://freefoam.sourceforge.net/doc/Doxygen/html
108 Further, most FreeFOAM applications and utilities support the '-doc' and
109 '-srcDoc' options, which will automatically display the API-documentation and
110 the source code of the application, respectively.
112 Help
113 ----
114 - http://freefoam.sourceforge.net
115 - https://freefoam.wiki.sourceforge.net/MailingLists
116 - http://www.cfd-online.com/Forums/openfoam/ *please only ask questions related
117 to _OpenFOAM_ there*.
119 Reporting Bugs in FreeFOAM
120 --------------------------
121 http://sourceforge.net/apps/mantisbt/freefoam
123 //////////////////////////////////////////////////////////
124 Process with: asciidoc -a toc -f data/asciidoc.conf README
126 Vim users, this is for you:
127 vim: ft=asciidoc sw=2 expandtab fenc=utf-8
128 //////////////////////////////////////////////////////////