README.md 2.02 KB
Newer Older
Chris Cantwell's avatar
Chris Cantwell committed
1 2 3 4 5 6 7 8 9 10
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
Dave Moxey's avatar
Dave Moxey committed
11
<http://www.nektar.info/>.
Chris Cantwell's avatar
Chris Cantwell committed
12

13

14 15 16 17 18 19 20
User Guide
----------
Detailed information on compiling, installing and using the software is
available in the User Guide. This document is available as a pre-compiled PDF
from the downloads section of the project website.


21 22 23 24 25 26 27 28 29
Tutorials
---------
A number of tutorials are available, designed to walk the user through the
basics of spectral/hp element methods, through the use of individual solvers and
performing specific types of calculations.

The tutorials are available from <http://doc.nektar.info/tutorials/latest>.


Chris Cantwell's avatar
Chris Cantwell committed
30 31 32
Pre-requisites
--------------
Nektar++ requires the following software to be installed on the users system:
Dave Moxey's avatar
Dave Moxey committed
33 34 35 36

- CMake
- BLAS/LAPACK

Chris Cantwell's avatar
Chris Cantwell committed
37 38 39 40 41 42 43 44
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
-----------
Dave Moxey's avatar
Dave Moxey committed
45 46
On most UNIX-based systems a default compilation can be performed using the
following commands from the top-level of the source tree:
Chris Cantwell's avatar
Chris Cantwell committed
47

Dave Moxey's avatar
Dave Moxey committed
48 49 50 51
    mkdir build
    cd build
    cmake ..
    make
Chris Cantwell's avatar
Chris Cantwell committed
52 53

To alter the build configuration (for example, to enable parallel execution
Dave Moxey's avatar
Dave Moxey committed
54
support) we recommend using the `ccmake` command instead of `cmake`. 
Chris Cantwell's avatar
Chris Cantwell committed
55 56 57 58 59 60 61

For more detailed operating-system specific instructions, please see the
User Guide.


Installation
------------
Dave Moxey's avatar
Dave Moxey committed
62 63 64
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
Chris Cantwell's avatar
Chris Cantwell committed
65 66
UNIX-based systems run:

Dave Moxey's avatar
Dave Moxey committed
67
    make install