Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

sync README.md to README, hopefully soon automake will like the forme…

…r...
  • Loading branch information...
commit e709efa036230a51dc34fe0a0e59932b27fd3f16 1 parent e3cd714
@benkirk benkirk authored
Showing with 48 additions and 28 deletions.
  1. +48 −28 README
View
76 README
@@ -5,17 +5,17 @@ For generic installation instructions refer also to the file INSTALL.
Build Process
-------------
- (0) ./bootstrap
- (optional, needed if you will modify the GNU autotools build system)
-
- (1) ./configure --prefix=/path/to/libmesh/install
+0. ./bootstrap
+ (optional, needed if you will modify the GNU autotools build system)
- (2) make
+1. ./configure --prefix=/path/to/libmesh/install
+
+2. make
+
+3. make check
+ (optional, runs the example programs and unit tests when possible)
- (3) make check
- (optional, runs the example programs and unit tests when possible)
-
- (4) make install
+4. make install
METHODS
@@ -25,30 +25,30 @@ libMesh supports the notion of multiple methods - that is, compilation
settings used to build the library. The major methods supported by
the library are:
- opt: Fully Optimized mode, with little to no error checking. No debugging
- symbols are included in the resulting library. Agressive optimization
- flags are used.
+* opt: Fully Optimized mode, with little to no error checking. No debugging
+ symbols are included in the resulting library. Agressive optimization
+ flags are used.
- dbg: Full debugging mode - all useful compiler warnings are enabled,
- as well as robust internal state checking.
+* dbg: Full debugging mode - all useful compiler warnings are enabled,
+ as well as robust internal state checking.
- devel: Use high levels of compiler optimization, but also enable internal
- state checking. Debugging symbols are included, but the resulting
- code is not always easy to navigate in a debugger because of
- compiler optimizations.
+* devel: Use high levels of compiler optimization, but also enable internal
+ state checking. Debugging symbols are included, but the resulting
+ code is not always easy to navigate in a debugger because of
+ compiler optimizations.
- pro: Optimized code path with compiler flags suitable for use with gprof.
+* pro: Optimized code path with compiler flags suitable for use with gprof.
- oprof: Optimized code path with compiler flags suitable for use with oprofile.
+* oprof: Optimized code path with compiler flags suitable for use with oprofile.
To select a set of methods, you can pass them to configure in one of two ways:
-$ ./configure --with-methods="opt dbg devel"
+ $ ./configure --with-methods="opt dbg devel"
or
-$ ./configure METHODS="devel oprof"
+ $ ./configure METHODS="devel oprof"
If unspecified, the three METHODS="opt dbg devel" are default.
@@ -61,11 +61,31 @@ feature when needed to support multiple compilers. For example, on a system
where multiple compilers are availble and accessible via modules, you can share
the same source tree by creating a subdirectory for each compiler build:
-$ export LIBMESH_SRC=/local/libmesh
-$ cd $LIBMESH_SRC
-$ module load gcc/4.6
-$ cd $LIBMESH_SRC && mkdir gcc-4.6 && cd gcc-4.6 && ../configure && make && make install
-$ module swap gcc intel/12.1
-$ cd $LIBMESH_SRC && mkdir intel-12.1 && cd intel-12.1 && ../configure && make && make install
+ $ export LIBMESH_SRC=/local/libmesh
+ $ cd $LIBMESH_SRC
+ $ module load gcc/4.6
+ $ cd $LIBMESH_SRC && mkdir gcc-4.6 && cd gcc-4.6 && ../configure && make && make install
+ $ module swap gcc intel/12.1
+ $ cd $LIBMESH_SRC && mkdir intel-12.1 && cd intel-12.1 && ../configure && make && make install
+
+
+Dependencies
+============
+
+Requirements
+------------
+
+libMesh has no required dependencies other than a reasonably modern C
+& C++ compiler. To run on distributed memory platforms in parallel
+you will also need MPI.
+
+Optional Packages
+-----------------
+
+We support a large number of optional packages, some of which are
+distributed inside the ./contrib directory and are compiler directly
+with libMesh, others can be used from third-party installation. For a
+list of supported packages and optional dependencies see
+[here](http://libmesh.sourceforge.net/externalsoftware.php)
[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/52c0727babae956821cca66c19c68908 "githalytics.com")](http://githalytics.com/libMesh/libmesh)
Please sign in to comment.
Something went wrong with that request. Please try again.