Commit f645355d authored by Chris Cantwell's avatar Chris Cantwell

Added README file.

parent b86b5337
Nektar++
========
Nektar++ is an open-source software framework designed to support the
development of high-performance scalable solvers for partial differential
equations (PDEs) using the spectral/hp element method.
This package consists of a set of libraries (the framework) and a number of
pre-written PDE solvers for a selection of application domains.
The software and User Guide is available for download from
http://www.nektar.info
Pre-requisites
--------------
Nektar++ requires the following software to be installed on the users system:
- CMake
- BLAS/LAPACK
Additional software is also required. This can either be installed system-wide
or it can be downloaded and compiled automatically during the build process.
For more detailed information, please see the User Guide.
Compilation
-----------
On most UNIX-based systems a default compilation can be performed using the following commands from the top-level of the source tree:
mkdir build
cd build
cmake ..
make
To alter the build configuration (for example, to enable parallel execution
support) we recommend using the 'ccmake' command instead of 'cmake'.
For more detailed operating-system specific instructions, please see the
User Guide.
Installation
------------
The default installation location is in a 'dist' subdirectory of the 'build'
directory. This can be changed by setting the 'CMAKE_INSTALL_PREFIX' option
using 'ccmake'. To install the compiled libraries, solvers and header files, on
UNIX-based systems run:
make install
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