Manual

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

• Prerequisites
  • Supported platforms
  • Supported compilers
  • Software and libraries
• Getting HPX
• Building HPX
  • Basic information
  • Most important CMake options
  • Build types
  • Platform specific build recipes
• CMake options
  • Variables that influence how HPX is built
  • Generic options
  • Build Targets options
  • Thread Manager options
  • AGAS options
  • Parcelport options
  • Profiling options
  • Debugging options
  • Modules options
  • Additional tools and libraries used by HPX
• Migration guide
  • OpenMP
  • Intel Threading Building Blocks (TBB)
  • MPI
• Building tests and examples
  • Tests
  • Examples
• 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 blocking the main thread
  • Supply your own explicit startup function as the main HPX entry point
  • 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 applications
  • Synchronization objects
  • Execution control
  • High level parallel facilities
• Writing distributed applications
  • Global names
  • Posting 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
  • Debugging applications using core files
• Optimizing HPX applications
  • Performance counters
  • APEX integration
  • References
• Using the LCI parcelport
  • Basic information
  • Build HPX with the LCI parcelport
  • Run HPX with the LCI parcelport
  • Performance tuning of the LCI parcelport
• HPX runtime and resources
  • HPX thread scheduling policies
  • The HPX resource partitioner
• Miscellaneous
  • Error handling
  • Utilities in HPX
  • The HPX I/O-streams component
• Troubleshooting
  • Common issues
  • Useful suggestions