HPX - High Performance ParalleX


Quick Start

We use here the command-line, non-interactive CMake interface.

  1. Download and install CMake here: CMake Downloads. Version 2.8 is the minimally required version for HPX.
  2. Open a shell. Your development tools must be reachable from this shell through the PATH environment variable.
  3. Create a directory for containing the build. It is not supported to build HPX on the source directory. cd to this directory:

    $ mkdir mybuilddir
    $ cd mybuilddir
  4. Execute this command on the shell replacing path/to/hpx/ with the path to the root of your HPX source tree:

    $ cmake path/to/hpx

CMake will detect your development environment, perform a series of tests and will generate the files required for building HPX. CMake will use default values for all build parameters. See the Options and Variables section for fine-tuning your build.

This can fail if CMake can't detect your toolset, or if it thinks that the environment is not sane enough. On this case make sure that the toolset that you intend to use is the only one reachable from the shell and that the shell itself is the correct one for you development environment. CMake will refuse to build MinGW makefiles if you have a POSIX shell reachable through the PATH environment variable, for instance. You can force CMake to use a given build tool, see the Basic CMake Usage section.

[Caution] Caution

The ccmake user interface program which wraps cmake and visualizes the current settings of the file CMakeCache.txt (that is where cmake stores all build settings) can be invoked with command line arguments in the same way as cmake. However, invoking ccmake this way does yield different results than the equivalent cmake invocation. This is a problem in ccmake which can cause subtle errors while building HPX.

Our suggestion is not use command line arguments to ccmake to alter the build configuration. Use the cmake command instead.