~fenics-core/dolfin/1.0.x

2479 by Garth N. Wells
Add some basic build & install instructions.
1
Requirements
2
------------
3
5055 by Anders Logg
Update ChangeLog and INSTALL
4
DOLFIN uses CMake for configuration and installation. DOLFIN also
5
relies on a number of other third-party libraries. Your system will be
6
probed for these libraries as part of the configuration process.
2479 by Garth N. Wells
Add some basic build & install instructions.
7
8
Simple build and install
5055 by Anders Logg
Update ChangeLog and INSTALL
9
------------------------
10
11
In the simplest case, just issue the commands
12
13
  cmake .
14
  make install
15
16
This will first configure DOLFIN for your system and then compile and
17
install DOLFIN in your system's default installation direcory, for
18
example in /usr/local/ or /opt/local/.
19
20
Local installation
21
------------------
22
23
It may sometimes be advantageous to install DOLFIN locally as part
24
of the DOLFIN source tree. To do this, simply type
25
26
  ./cmake.local
27
28
This configures, compiles, and install DOLFIN in a directory named
29
'local' in the DOLFIN source tree.
30
31
Customized builds
2479 by Garth N. Wells
Add some basic build & install instructions.
32
-----------------
33
5055 by Anders Logg
Update ChangeLog and INSTALL
34
To customize the configuration of DOLFIN, it is convenient to use one
35
of the graphical user interfaces for CMake, such as either ccmake or
36
cmake-gui. These frontends to CMake allow simple manipulation of
37
variables that control the configuration of DOLFIN.
38
39
It is often useful to build DOLFIN 'out-of-source' which means that
40
all files generated by the build process end up in a separate
41
directory without cluttering the source tree. To make an out-of-source
42
build for DOLFIN using a graphical interface to CMake, simply type
43
44
  mkdir build
45
  cd build
46
  cmake-gui ..
47
  make install
5135.1.2 by Anders Logg
Update INSTALL file with instructions for building demos
48
49
Building demos and tests
50
------------------------
51
52
To build demos, enter the build directory (if any) and type
53
54
  make demo
55
56
This will build all demos. To build a specific demo, just name the
57
demo you want to build, for example the Poisson demo, and type
58
59
  make poisson-demo
60
61
Alternatively, you may navigate to the demo directory directly, for
62
example demo/pde/poisson/cpp and then build the demo using CMake as
63
above:
64
65
  cmake .
66
  make
67
68
Python demos can be run directly by navigating to the directory of the
69
demo and typing
70
71
  python demo.py