~njansson/dolfin/hpc

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Niclas Jansson
  • Date: 2011-06-10 09:10:57 UTC
  • mto: This revision was merged to the branch mainline in revision 3054.
  • Revision ID: njansson@csc.kth.se-20110610091057-73jgi4ulxbqgv1ya
Updated leftovers

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Requirements
2
 
------------
3
 
 
4
 
DOLFIN uses a SCons-based build system. You will there need SCons to build
5
 
and install DOLFIN. SCons is available as a package for most operating systems.
6
 
Alternatively, it can be found at www.scons.org.
7
 
 
8
 
DOLFIN depends on various packages. Details of the dependencies can found at 
9
 
 
10
 
  http://www.fenics.org/wiki/Installing_DOLFIN
11
 
 
12
 
 
13
 
Simple build and install
14
 
--------------------------
15
 
 
16
 
In the directory containing the DOLFIN source code, type
17
 
 
18
 
  scons enableDemos=yes
19
 
 
20
 
This will configure and build DOLFIN and the demo programs. To install the 
21
 
library, type
22
 
 
23
 
  scons install prefix=PREFIX
24
 
 
25
 
which will install DOLFIN files in PREFIX. Depending on where DOLFIN has been
26
 
installed, it may be necessary to set various environment variables. A helper 
27
 
file 'dolfin.conf' is generated to do this for bash shell users. Type
28
 
 
29
 
  source ./dolfin.conf
30
 
 
31
 
to set the necessary variables. It should now be possible to run the demo 
32
 
programs. To install locally (within the DOLFIN tree), type
33
 
 
34
 
  ./scons.local
35
 
 
36
 
 
37
 
Customised builds
38
 
-----------------
39
 
 
40
 
Various options for building DOLFIN are printed to the screen by typing
41
 
 
42
 
  scons -h
 
1
 
 
2
DOLFIN HPC
 
3
----------
 
4
 
 
5
Background:
 
6
 
 
7
DOLFIN HPC is a special branch of DOLFIN optimized for distributed
 
8
memory architectures. Based on DOLFIN 0.8.0, the HPC branch is
 
9
parallelized using a hybrid MPI/OpenMP approach with parallel local
 
10
mesh refinement, dynamic load balancing and parallel I/O (MPI
 
11
I/O). The implementation is portable and has been verified to work on
 
12
several different architectures such as SGI Origin systems, IBM
 
13
BlueGene/L and Cray XT6-XE6 systems.
 
14
 
 
15
 
 
16
The package dependencies of DOLFIN HPC are:
 
17
 
 
18
    * ufc 1.1
 
19
    * ffc 0.5.1
 
20
    * ParMETIS
 
21
    * Supported LA-backend (currently PETSc or JANPACK)
 
22
 
 
23
Installation:
 
24
 
 
25
DOLFIN HPC uses autotools. To build and install the package, follow
 
26
these steps:
 
27
 
 
28
1. ./configure
 
29
2. make 
 
30
3. make install
 
31
 
 
32
DOLFIN HPC can be build with various options, issue ./configure --help
 
33
to list all of them.
 
34
 
43
35