Debian Codegraph @

python/doc/source/installation.rst

raw
1 .. DOLFIN installation docs
2
3 ============
4 Installation
5 ============
6
7
8 Quick start
9 ===========
10
11 You probably want to read the `FEniCS download and installation web
12 page <https://fenicsproject.org/download/>`_ if you just want to get
13 FEniCS installed as quickly as possible.
14
15
16 Building from source
17 ====================
18
19
20 Dependencies
21 ------------
22
23 DOLFIN requires a compiler that supports the C++11 standard.
24
25 The required and optional DOLFIN dependencies are listed below.
26
27 Required
28 ^^^^^^^^
29
30 - Boost (http://www.boost.org), with the following compiled Boost
31 components
32
33 - filesystem
34 - iostreams
35 - program_options
36 - timer
37
38 - CMake (https://cmake.org)
39 - Eigen3 (http://eigen.tuxfamily.org)
40 - FFC (https://bitbucket.org/fenics-project/ffc)
41 - pkg-config (https://www.freedesktop.org/wiki/Software/pkg-config/)
42 - Python 3 (used by the build system)
43 - zlib
44
45
46 Required for Python interface
47 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48
49 - Python 3 (including header files)
50 - pybind11 (https://github.com/pybind/pybind11)
51 - NumPy (http://www.numpy.org)
52 - ply (https://github.com/dabeaz/ply)
53
54
55 Optional
56 ^^^^^^^^
57
58 - HDF5 (with MPI support enabled if building DOLFIN with MPI support)
59 - MPI
60 - ParMETIS [1]_
61 - PETSc (strongly recommended) [2]_
62 - SCOTCH and PT-SCOTCH [1]_
63 - SLEPc
64 - Suitesparse [1]_
65 - Trilinos
66
67
68 Optional for the Python interface
69 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
70
71 - Matplotlib (required for plotting)
72 - mpi4py
73 - petsc4py
74 - slepc4py
75
76
77 .. [1] It is strongly recommended to use the PETSc build system to
78 download and configure and build these libraries.
79
80 .. [2] Its is recommended to configuration with ParMETIS, PT-SCOTCH,
81 MUMPS and Hypre using the
82 ``--download-parmetis --download-ptscotch --download-suitesparse
83 --download-mumps --download-hypre``