Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(Re)move APEX readme #3552

Merged
merged 2 commits into from
Nov 20, 2018
Merged

(Re)move APEX readme #3552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a553506
Move APEX integration readme into main documentation
msimberg Nov 2, 2018
7fa3fec
Remove duplicate --hpx:print-counter-at documentation
msimberg Nov 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions cmake/templates/conf.py.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,12 @@ rst_prolog += '''
.. |macports| replace:: MacPorts
.. _macports: https://www.macports.org/

.. |apex| replace:: APEX
.. _apex: https://khuck.github.io/xpress-apex/
.. |apex_hpx_doc| replace:: APEX |hpx| documentation
.. _apex_hpx_doc: https://khuck.github.io/xpress-apex/usage/#hpx-louisiana-state-university
.. |tau| replace:: TAU
.. _tau: https://www.cs.uoregon.edu/research/tau/home.php
.. |cmake| replace:: CMake
.. _cmake: https://www.cmake.org
.. |ctest| replace:: CTest
Expand Down
177 changes: 0 additions & 177 deletions docs/README.apex_integration
View file
Open in desktop

This file was deleted.

6 changes: 0 additions & 6 deletions docs/sphinx/manual/launching_and_configuring_hpx_applications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1628,12 +1628,6 @@ The predefined command line options for any application using
reset all performance counter(s) specified with :option:`--hpx:print-counter`
after they have been evaluated.

.. option:: --hpx:print-counter-at

print the performance counter(s) specified with :option:`--hpx:print-counter`
(or :option:`--hpx:print-counter-reset` at the given point in time, possible
argument are values: ``startup``, ``shutdown`` (default), ``noshutdown``.

.. option:: --hpx:print-counters-locally

Each :term:`locality` prints only its own local counters. If this is used
Expand Down
19 changes: 15 additions & 4 deletions docs/sphinx/manual/optimizing_hpx_applications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
..
Copyright (C) 2007-2017 Hartmut Kaiser
2014 University of Oregon

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)
Expand Down Expand Up @@ -282,10 +283,6 @@ The following table summarizes the available command line options:
* * ``--hpx:reset-counters``
* reset all performance counter(s) specified with ``--hpx:print-counter``
after they have been evaluated)
* * ``--hpx:print-counter-at``
* print the performance counter(s) specified with ``--hpx:print-counter``
(or ``--hpx:print-counter-reset``) at the given point in time, possible
argument are values: ``startup``, ``shutdown`` (default), ``noshutdown``.

While the options ``--hpx:list-counters`` and ``--hpx:list-counter-infos`` give
a short listing of all available counters, the full documentation for those can
Expand Down Expand Up @@ -2615,3 +2612,17 @@ system and application performance.
:c:macro:`HPX_ACTION_USES_MESSAGE_COALESCING_NOTHROW`).

.. [#] A message can potentially consist of more than one :term:`parcel`.

APEX integration
================

|hpx| provides integration with |apex|_, which is a framework for application
profiling using task timers and various performance counters. It can be added as
a ``git`` submodule by turning on the option :option:`HPX_WITH_APEX:BOOL` during
|cmake|_ configuration. |tau|_ is an optional dependency when using |apex|_.

To build |hpx| with |apex|_ add :option:`HPX_WITH_APEX`\ ``=ON``, and,
optionally, ``TAU_ROOT=$PATH_TO_TAU`` to your |cmake|_ configuration. In
addition, you can override the tag used for |apex|_ with the
:option:`HPX_WITH_APEX_TAG` option. Please see the |apex_hpx_doc|_ for detailed
instructions on using |apex|_ with |hpx|.