-
Notifications
You must be signed in to change notification settings - Fork 1
/
INSTALL
108 lines (72 loc) · 2.54 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
FOAM - Modular Adative Optics Framework
=======================================
FOAM follows standard installation routines. If you checked this source
out from git though, you need to take a few extra steps. For information
about specific platforms and compilers see the INSTALL.default file.
Prerequisites
=============
FOAM depends on a number of other libraries. A custom library that is required
is LibSIU (see below).
A list of other requirements FOAM has:
- libm, pthread (should be available on all POSIX systems)
- cfitsio
- sigc++-2.0 >= 2.0
- libgsl >= 1.11
Other libraries that are used by specific parts of FOAM:
* Full simulation
- libz (optional, for LibSIU::ImgData)
- libics (optional, for LibSIU::ImgData)
- fftw3 >= 3.1.2
* Gui
- gtkmm-2.4 >= 2.6
- gthread-2.0 >= 2.16.6
- opengl, glu, glut
- gtkglextmm-1.2 >= 1.2.0
To find out what specific libraries are required, run
- dpkg-depcheck -d ./configure
LibSIU
======
Before installing FOAM, please install libsiu first. This utility library
is available at <https://github.com/tvwerkhoven/libsiu>. To install this
software:
- git clone https://github.com/tvwerkhoven/libsiu.git libsiu
- cd libsiu
- autoreconf -sfi
- ./configure
- make
After that, point to the libsiu/src directory when installing FOAM, i.e.
- cd $FOAMDIR
- ln -s $LIBSIUDIR libsiu
FOAM
====
To install FOAM when checking out from the git repository, please first run:
- ./version.sh
- autoreconf -sfi
followed by the regular installation procedure:
- ./configure --help
- ./configure
- make
- make install
To make the test programs as well, run
- make check
For information about specific platforms and compilers see the
INSTALL.default file.
For more information on running or testing the software, see the README file.
Documentation
=============
The FOAM sourcecode is highlighted with Doxygen-compatible comments. To
extract this information and present it in a easily navigatable format, run:
- make all
or run `doxygen doxyfile` in the docs/ directory.
in the source root. The documentation will then be available in HTML and
LaTeX formats in docs/.
N.B. To generate documentation you need doxygen and graphviz to generate
call-graphs!
If you need more extensive documentation, run
- ./configure --enable-extdocs
before make all to enable more verbose documentation. The difference is in
whether the more verbose docs/doxyfile-debug or the somewhat less
frightening docs/doxyfile is used while generating docs. You can also manually
make the documentation by running
- cd docs
- doxygen [doxyfile-debug|doxyfile]