diff --git a/README b/README index 4ec88afb50f0cde38d12d9c7d0ca49a8bbe3ed0b..afa211672c70cb60234f36743c051b3a490becb1 100644 --- a/README +++ b/README @@ -2,13 +2,31 @@ ALBERTA is an Adaptive multi-Level finite element toolbox using Bisectioning refinement and Error control by Residual Techniques for scientific Applications. +------------------------------------------------------------------------------- + Contents ======== I. Introduction + II. External Packages (both required and optional packages) + 1.) Required Packages + OpenGL + BLAS (with examples) + 2.) Optional Packages + gltools + GRAPE + alternate compilers + III. Configure Options -IV. Compiler flags + 1.) Non-standard behaviour of ALBERTA + 2.) Options affecting which versions of ALBERTA are built + 3.) Options controlling the search-path for external libraries + +IV. Compiler flags (with examples) + +------------------------------------------------------------------------------- + I) Introduction =============== @@ -202,8 +220,8 @@ alternate compilers Many CPU-vendors distribute highly optimizing compilers for their specific CPU architecture. Often those compilers generate much faster code than even a modern gcc. Sometimes - they are available at no cost, at least for private and - research use. + they are available at no costs, at least for private and + academical use. III) Configure Options @@ -219,10 +237,14 @@ The remaining (i.e. ALBERTA specific) options are explained here: 1.) Non-standard behaviour of ALBERTA ------------------------------------- -BIG FAT NOTE: the default installation prefix of the ALBERTA-package +BIG FAT NOTE: the _default_ installation prefix of the ALBERTA-package is _NOT_ the default GNU installation prefix which would be -/usr/local/ on Un*x systems, but it is the build-directory. I.e. when -compiling ALBERTA below +/usr/local/ on Un*x systems, but it is the build-directory. Of course, +you can change the default behavior by using the "--prefix=PREFIX" +switch when running configure (see ./INSTALL). However, the default +layout is like follows: + +When compiling ALBERTA below /usr/people/claus/alberta-1.2/ @@ -241,7 +263,7 @@ libtool.alberta will reside in and finally the demo package (under the name alberta-1.2.demo.tar.gz) will be copied to - /usr/people/claus/alberta-1.2/libexec/share/ + /usr/people/claus/alberta-1.2/share/ This will be the layout after running "make install". @@ -284,7 +306,7 @@ The options below control which of them are actually created. surrounding space has dimension 3. (default: disabled) --enable-el-index - Additionally build ALBERTA libraries which assigns unique + Additionally build ALBERTA libraries which assigns an unique index to each element. Normally, this is not needed but it can be handy for debugging purposes. (default: disabled) @@ -293,8 +315,8 @@ The options below control which of them are actually created. information. On some systems (or better: with some compilers) optimization and debugging are mutual exclusive, therefore there are separate ALBERTA libraries which are compiled with - optimization, but without debugging information, and another - versions which is compiled without optimization, but with + optimization, but without debugging information, and other + versions which are compiled without optimization, but with debugging. (default: enabled) @@ -314,10 +336,10 @@ following options: --with-PKG-name=NAME Alter the default name of the package, e.g. "--with-opengl-name=MesaGL" or "--with-blas-name=cxml". - NOTE: it is possible to specify more than one library. E.g on - (some versions of?) Solaris the BLAS-library is called - "libsunperf.so". If you want to link with this library using - gcc and g77, then you need to specify + NOTE: it is possible to specify more than one library. For + example on (some versions of?) Solaris the BLAS-library is + called "libsunperf.so". If you want to link with this library + using gcc and g77, then you need to specify "--with-blas-name=sunperf -lfui -lfsu -lsunmath" @@ -338,7 +360,8 @@ following options: e.g. "--with-opengl-include=/usr/people/claus/software/include/". The following quotes the relevant fragment of the online-help obtained -by running "configure --help" +by running "configure --help". Please see the file ./INSTALL for the +notation (e.g. PREFIX, EPREFIX etc.). --with-blas-name=NAME use NAME as the name of the blas library (without leading "lib" prefix and trailing suffix). Default: @@ -425,7 +448,7 @@ Examples: 1.) gcc with a Pentium 4 - ./configure <blablabla> \ + ./configure [OTHER OPTIONS] \ CFLAGS="-march=pentium4 -mfpmath=sse" \ FFLAGS="-march=pentium4 -mfpmath=sse" make @@ -437,13 +460,13 @@ or (assuming a Bourne-shell) FFLAGS="-march=pentium4 -mfpmath=sse" export CFLAGS FFLAGS - ./configure <blablabla> + ./configure [OTHER OPTIONS] make make install or - ./configure <blablabla> + ./configure [OTHER OPTIONS] make CFLAGS="-march=pentium4 -mfpmath=sse" \ FFLAGS="-march=pentium4 -mfpmath=sse" make install @@ -451,8 +474,8 @@ or 2.) Pentium 4 with icc and with Intel "math kernel library" (BLAS implementation) - ./configure <blablabla> \ - CC=icc CFLAGS="-mcpu=pentium4" ALBERTA_OPTIMIZE_CFLAGS="-O3" \ + ./configure [OTHER OPTIONS] \ + CC=icc CFLAGS="-xW" ALBERTA_OPTIMIZE_CFLAGS="-O3" \ ALBERTA_DEBUG_CFLAGS="-O0 -g" \ F77=ifc FFLAGS="-xW -O3" \ --with-blas-name=mkl --with-blas-lib=/opt/intel/mkl61/lib/32/