To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit ee0dd3ad authored by Simone Deparis's avatar Simone Deparis
Browse files

updating the license and readme information for the release

parent eb2cfa5f
# @HEADER
# *******************************************************************************
#
#
# Copyright (C) 2004, 2005, 2007 EPFL, Politecnico di Milano, INRIA
# Copyright (C) 2010 EPFL, Politecnico di Milano, Emory University
#
# Copyright (C) 2011,2012,2013 EPFL, Politecnico di Milano, Emory University
#
# This file is part of LifeV.
#
#
# LifeV is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
#
# LifeV is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
#
# You should have received a copy of the GNU Lesser General Public License
# along with LifeV. If not, see <http://www.gnu.org/licenses/>.
#
# *******************************************************************************
# @HEADER
\ No newline at end of file
# @HEADER
The copyright header can be found in Copyright.txt in the root folder.
This file contained a link to the licensing section of the Trilinos website.
Do we also need additional licensing information?
The copyright and license information that cover all the files of this sofware
distribution can be found in Copyright.txt in the root folder.
===================================
== OUT OF DATE as of 9.03.2012 ==
== NEEDS UPDATING ! ==
===================================
LifeV (pronounced "life five")
the C++ parallel finite element library for the solution of PDEs.
For configuring and building LifeV with CMake the following variables are of importance
(provide them as arguments to the cmake command -D VARIABLE_NAME:VARIABLE_TYPE=VALUE):
Distributed under LGPL by CMCS – EPFL, E(CM)2 – Emory, MOX – Polimi, REO, ESTIME– INRIA.
about 30 active developers.
* CMAKE_CXX_COMPILER (STRING) - set this to the desired C++ compiler (g++, c++, mpicxx, mpixlcxx etc.)
By default, this is set to "mpicxx"
* CMAKE_CXX_FLAGS (STRING) - provide a string containing additional compiler flags (this variable
can be used to override the default settings, like optimization level, of the build type
* CMAKE_BUILD_TYPE (STRING) - set this to Debug ( -Wall -g) or Release (-O2).
By default, this is set to "Debug"
* LIFE_EXTRA_LINK_LINE (STRING) - use this to specify flags for the linker or append additional libraries
to the link line
* CMAKE_INSTALL_PREFIX (PATH) - set this to the desired install location for LifeV
Third party library dependencies:
* ParMETIS (required) - if it is installed in a non-standard location, you will need to set
PARMETIS_ROOT (PATH) to the appropriate location
* MPI - if you plan on using the MPI wrappers (mpicxx, mpixlcxx etc.), then you need to set
LIFE_USE_MPI_WRAPPER (BOOL), and no additional information is required about the MPI installation.
Otherwise, the scripts will try to determine the location of MPI headers and libraries.
In case of a non standard installation, please provide the location of MPI through the
MPI_INCLUDE_PATH (PATH) and MPI_LIBRARIES (STRING) variables.
* Trilinos (required) - if the Trilinos libraries aren't installed in a standard location,
please set Trilinos_ROOT (PATH) to point to the installation
* UMFPACK (optional) - if planning to compile LifeV with UMFPACK support, please set LIFE_USE_UMFPACK
(BOOL) to TRUE. In the event of a non standard UMFPACK installation, please provide a hint
through UMFPACK_ROOT (PATH). Please note that the scripts expect that both UMFPACK, UFConfig and
AMD are installed in the "include" and "lib" subdirectories of UMFPACK_ROOT.
* LAPACK and BLAS (required) - in the case of non-standard location and name for the LAPACK and BLAS
libraries, they can be specified through the LAPACK_LIBRARIES (STRING) and BLAS_LIBRARIES (STRING)
variables.
* Boost (required) - in the case of a non-standard Boost installation, please provide it's location
through the BOOST_ROOT (PATH) variable
* HDF5 (optional) - the HDF5 support in LifeV can be activated with LIFE_USE_HDF5 (BOOL).
Non standard paths can be provided through HDF5_ROOT (PATH)
* QHULL (optional) - the QHULL support in LifeV is activated with LIFE_USE_QHULL (BOOL).
Non standard paths can be provided with QHULL_ROOT (PATH)
All the optional third party libraries are disabled by default.
After the configuration phase, compile the libraries with "make", tests can be compiled individually with
"make <NAME_OF_TEST>" or collectively with "make all_tests". Running the testsuite is done by issuing
"ctest".
The configure scripts respond to other default CMake variables. These aren't needed in most cases, but
additional information about them can be found on the official CMake website.
The collection of CMake scripts for LifeV is work in progress.
----------------------------------------------------------------------------
Radu Popescu, EPFL - CMCS
<radu.popescu@epfl.ch>
Simone Deparis, EPFL - CMCS
<simone.deparis@epfl.ch>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment