.. Copyright (c) 2007-2020 Louisiana State University
SPDX-License-Identifier: BSL-1.0 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)
|circleci_status| |codacy| |coveralls| |JOSS| |zenodo_doi|
development (master) <https://hpx-docs.stellar-group.org/branches/master/html/index.html>
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.
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.
The HPX project is a meritocratic, consensus-based community project. Anyone
with an interest in the project can join the community, contribute to the
project design and participate in the decision making process.
This document <http://hpx.stellar-group.org/documents/governance/>_ describes
how that participation takes place and how to set about earning merit within
the project community.
If you plan to use HPX we suggest to start with the latest released version
which can be downloaded
To quickly get started with HPX on most Linux distributions you can read the
quick start guide
Detailed instructions on building and installing HPX on various platforms can be
The full documentation for the latest release of HPX can always be found
If you would like to work with the cutting edge version of this repository
master branch) the documentation can be found
We strongly recommend that you follow the current health status of the master
branch by looking at our
continuous integration results website <https://cdash.cscs.ch//index.php?project=HPX>. While we try to keep the
master branch stable and usable, sometimes new bugs trick their way into the
code base. The
continuous integration service additionally tracks the current build status for
the master branch: |circleci_status|.
Codacy <https://www.codacy.com/>_ to assess the code quality of this
project: |codacy|. For our coverage analysis we rely on
Coveralls <https://coveralls.io/>_ to present the results: |coveralls|.
If you can't find what you are looking for in the documentation or you suspect
you've found a bug in HPX we very much encourage and appreciate any issue
reports through the
issue tracker for this Github project <https://github.com/STEllAR-GROUP/hpx/issues>_.
If you have any questions feel free to ask it over at
StackOverflow <https://stackoverflow.com>_ and tag the question with
For a full list of support options please see our
Support page <https://github.com/STEllAR-GROUP/hpx/blob/master/.github/SUPPORT.md>_.
We have adopted a
code of conduct <https://github.com/STEllAR-GROUP/hpx/blob/master/.github/CODE_OF_CONDUCT.md>_
for this project. Please refer to this document if you would like to know more
about the expectations for members of our community, with regard to how they
will behave toward each other.
Please find the project's gpg key, which is used to sign HPX releases
In publications, please use our paper in The Journal of Open Source Software as the main citation for HPX: |JOSS|. For referring to the latest release of HPX please use: |zenodo_doi|.
Past and current funding and support for HPX is listed
.. |circleci_status| image:: https://circleci.com/gh/STEllAR-GROUP/hpx/tree/master.svg?style=svg :target: https://circleci.com/gh/STEllAR-GROUP/hpx/tree/master :alt: HPX master branch build status
.. |zenodo_doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.598202.svg :target: https://doi.org/10.5281/zenodo.598202 :alt: Latest software release of HPX
.. |codacy| image:: https://api.codacy.com/project/badge/Grade/0b8cd5a874914edaba67ce3bb711e688 :target: https://www.codacy.com/gh/STEllAR-GROUP/hpx :alt: HPX Code Quality Assessment
.. |coveralls| image:: https://coveralls.io/repos/github/STEllAR-GROUP/hpx/badge.svg :target: https://coveralls.io/github/STEllAR-GROUP/hpx :alt: HPX coverage report
.. |JOSS| image:: https://joss.theoj.org/papers/022e5917b95517dff20cd3742ab95eca/status.svg :target: https://joss.theoj.org/papers/022e5917b95517dff20cd3742ab95eca :alt: JOSS Paper about HPX