Welcome to the HPX documentation!
Welcome to the HPX documentation!#
If you’re new to HPX you can get started with the Quick start guide. Don’t forget to read the Terminology section to learn about the most important concepts in HPX. The Examples give you a feel for how it is to write real HPX applications and the Manual contains detailed information about everything from building HPX to debugging it. There are links to blog posts and videos about HPX in Additional material.
If you can’t find what you’re looking for in the documentation, please:
open an issue on GitHub;
contact us on IRC, the HPX channel on the C++ Slack, or on our mailing list; or
read or ask questions tagged with HPX on StackOverflow.
You can find a comprehensive list of contact options on Support for deploying and using HPX.
See Citing HPX for details on how to cite HPX in publications. See HPX users for a list of institutions and projects using HPX.
There are also available a PDF version of this documentation as well as a Single HTML Page.
What is HPX?#
HPX is a C++ Standard Library for Concurrency and Parallelism. It implements all of the corresponding facilities as defined by the C++ Standard. Additionally, in HPX we implement functionalities proposed as part of the ongoing C++ standardization process. We also extend the C++ Standard APIs to the distributed case. HPX is developed by the STE||AR group (see People).
The goal of HPX is to create a high quality, freely available, open source implementation of a new programming model for conventional systems, such as classic Linux based Beowulf clusters or multi-socket highly parallel SMP nodes. At the same time, we want to have a very modular and well designed runtime system architecture which would allow us to port our implementation onto new computer system architectures. We want to use real-world applications to drive the development of the runtime system, coining out required functionalities and converging onto a stable API which will provide a smooth migration path for developers.
The API exposed by HPX is not only modeled after the interfaces defined by the C++11/14/17/20 ISO standard. It also adheres to the programming guidelines used by the Boost collection of C++ libraries. We aim to improve the scalability of today’s applications and to expose new levels of parallelism which are necessary to take advantage of the exascale systems of the future.
What’s so special about HPX?#
HPX exposes a uniform, standards-oriented API for ease of programming parallel and distributed applications.
It enables programmers to write fully asynchronous code using hundreds of millions of threads.
HPX provides unified syntax and semantics for local and remote operations.
HPX makes concurrency manageable with dataflow and future based synchronization.
It implements a rich set of runtime services supporting a broad range of use cases.
HPX exposes a uniform, flexible, and extendable performance counter framework which can enable runtime adaptivity
It is designed to solve problems conventionally considered to be scaling-impaired.
HPX has been designed and developed for systems of any scale, from hand-held devices to very large scale systems.
It is the first fully functional implementation of the ParalleX execution model.
HPX is published under a liberal open-source license and has an open, active, and thriving developer community.
- Quick start
- Getting HPX
- Building HPX
- CMake options
- Building tests and examples
- Creating HPX projects
- Starting the HPX runtime
- Launching and configuring HPX applications
- Writing single-node applications
- Writing distributed HPX applications
- Running on batch systems
- Debugging HPX applications
- Optimizing HPX applications
- Using the LCI parcelport
- HPX runtime and resources
- Why HPX?
- Additional material
- HPX V1.9.0 (TBD)
- HPX V1.8.1 (Aug 5, 2022)
- HPX V1.8.0 (May 18, 2022)
- HPX V1.7.1 (Aug 12, 2021)
- HPX V1.7.0 (Jul 14, 2021)
- HPX V1.6.0 (Feb 17, 2021)
- HPX V1.5.1 (Sep 30, 2020)
- HPX V1.5.0 (Sep 02, 2020)
- HPX V1.4.1 (Feb 12, 2020)
- HPX V1.4.0 (January 15, 2020)
- HPX V1.3.0 (May 23, 2019)
- HPX V1.2.1 (Feb 19, 2019)
- HPX V1.2.0 (Nov 12, 2018)
- HPX V1.1.0 (Mar 24, 2018)
- HPX V1.0.0 (Apr 24, 2017)
- HPX V0.9.99 (Jul 15, 2016)
- HPX V0.9.11 (Nov 11, 2015)
- HPX V0.9.10 (Mar 24, 2015)
- HPX V0.9.9 (Oct 31, 2014, codename Spooky)
- HPX V0.9.8 (Mar 24, 2014)
- HPX V0.9.7 (Nov 13, 2013)
- HPX V0.9.6 (Jul 30, 2013)
- HPX V0.9.5 (Jan 16, 2013)
- HPX V0.9.0 (Jul 5, 2012)
- HPX V0.8.1 (Apr 21, 2012)
- HPX V0.8.0 (Mar 23, 2012)
- HPX V0.7.0 (Dec 12, 2011)
- Citing HPX
- HPX users
- About HPX