HPX
1.2.0

User documentation

  • Why HPX?
  • Quick start
  • Terminology
  • Examples
  • Manual
    • HPX build system
    • Creating HPX projects
    • Starting the HPX runtime
    • Launching and configuring HPX applications
    • Writing single-node HPX applications
    • Writing distributed HPX applications
    • Running on batch systems
    • Debugging HPX applications
    • Optimizing HPX applications
    • HPX runtime and resources
    • Miscellaneous
  • Additional material

Reference

  • API reference

Developer documentation

  • Contributing to HPX

Other

  • Releases
  • About HPX
HPX
  • Docs »
  • Manual
  • Edit on GitHub

ManualΒΆ

The manual is your comprehensive guide to HPX. It contains detailed information on how to build and use HPX in different scenarios.

  • HPX build system
    • CMake basics
    • Prerequisites
    • Building HPX
    • Platform specific build recipes
    • CMake toolchains shipped with HPX
    • CMake variables used to configure HPX
  • Creating HPX projects
    • Using HPX with pkg-config
    • Using HPX with CMake-based projects
    • Using HPX with Makefile
  • Starting the HPX runtime
    • Re-use the main() function as the main HPX entry point
    • Supply your own main HPX entry point while blocking the main thread
    • Supply your own main HPX entry point while avoiding to block the main thread
    • Suspending and resuming the HPX runtime
    • Working of hpx_main.hpp
  • Launching and configuring HPX applications
    • Configuring HPX applications
    • Loading components
    • Logging
    • HPX Command Line Options
  • Writing single-node HPX applications
    • Using LCOs
    • Extended facilities for futures
    • High level parallel facilities
    • Using task blocks
  • Writing distributed HPX applications
    • Global names
    • Applying actions
    • Writing components
    • Segmented containers
  • Running on batch systems
    • How to use HPX applications with PBS
    • How to use HPX applications with SLURM
  • Debugging HPX applications
    • Using a debugger with HPX applications
    • Using sanitizers with HPX applications
  • Optimizing HPX applications
    • Performance counters
  • HPX runtime and resources
    • HPX thread scheduling policies
    • The HPX resource partitioner
  • Miscellaneous
    • Error handling
    • Utilities in HPX
    • The HPX I/O-streams component
Next Previous

© Copyright 2008-2018, The Ste||ar Group. Revision f52dc95.

Built with Sphinx using a theme provided by Read the Docs. Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)