← Back to branch summary

~elmer-csc-ubuntu/elmercsc/devel

« back to all changes in this revision

Viewing changes to elmergrid/src/metis-5.1.0/BUILD.txt

  • Committer: GitHub
  • Author(s): Peter R
  • Date: 2017-10-04 13:47:14 UTC
  • mfrom: (575.1.17)
  • Revision ID: git-v1:91780af69137b74ec539fedc4ad70c9ec52d732a
Merge pull request #115 from ElmerCSC/metis_update

Updated to new Metis API for devel branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
elmergrid/src/metis-5.1.0/BUILD.txt
 
1
------------------------------------------------------------------------------
 
2
Building METIS requires CMake 2.8, found at http://www.cmake.org/, as
 
3
well as GNU make. Assumming CMake and GNU make are installed, two
 
4
commands should suffice to build metis:
 
5
 
 
6
     $ make config
 
7
     $ make
 
8
 
 
9
 
 
10
Configuration
 
11
-------------
 
12
METIS is primarily configured by passing options to make config. For
 
13
example:
 
14
 
 
15
     $ make config shared=1 cc=gcc-4.2
 
16
 
 
17
would configure metis to be built as a shared library using GCC 4.2.
 
18
 
 
19
Common configuration options are:
 
20
  cc=[compiler]   - The C compiler to use [default is determined by CMake]
 
21
  shared=1        - Build a shared library instead of a static one 
 
22
                    [off by default]
 
23
  prefix=[PATH]   - Set the installation prefix [/usr/local/ by default]
 
24
 
 
25
Advanced debugging related options:
 
26
  gdb=1       - Build with support for GDB [off by default]
 
27
  debug=1     - Enable debugging support [off by default]
 
28
  assert=1    - Enable asserts [off by default]
 
29
  assert2=1   - Enable very expensive asserts [off by default]
 
30
 
 
31
METIS' index and real data type size can be configured by editing
 
32
include/metis.h.
 
33
 
 
34
 
 
35
Installation
 
36
------------
 
37
To install METIS, run
 
38
 
 
39
    $ make install
 
40
 
 
41
The default installation prefix is /usr/local. To pick an installation 
 
42
prefix for METIS pass prefix=[path] to make config. For example,
 
43
 
 
44
    $ make config prefix=~/myroot/
 
45
 
 
46
will cause METIS to be installed in ~/myroot/ when make install is run.
 
47
 
 
48
 
 
49
Other make commands
 
50
-------------------
 
51
   $ make uninstall 
 
52
          Removes all files installed by 'make install'.
 
53
   
 
54
   $ make clean 
 
55
          Removes all object files but retains the configuration options.
 
56
   
 
57
   $ make distclean 
 
58
          Performs clean and completely removes the build directory.
 
59
 
 
60
------------------------------------------------------------------------------