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.

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

Prepare V1.0 #2252

Merged
merged 7 commits into from Jul 16, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions CMakeLists.txt
Expand Up @@ -45,9 +45,9 @@ endif()
################################################################################
project(HPX CXX C)

set(HPX_MAJOR_VERSION 0)
set(HPX_MINOR_VERSION 9)
set(HPX_PATCH_LEVEL 99)
set(HPX_MAJOR_VERSION 1)
set(HPX_MINOR_VERSION 0)
set(HPX_PATCH_LEVEL 0)
set(HPX_VERSION "${HPX_MAJOR_VERSION}.${HPX_MINOR_VERSION}.${HPX_PATCH_LEVEL}")
set(HPX_LIBRARY_VERSION "${HPX_VERSION}")
set(HPX_SOVERSION ${HPX_MAJOR_VERSION})
Expand Down
67 changes: 11 additions & 56 deletions README.rst
Expand Up @@ -51,20 +51,20 @@ What's so special about HPX?
active, and thriving developer community.


The documentation for the latest release of HPX (currently V0.9.11) can be
`found here <http://stellar.cct.lsu.edu/files/hpx-0.9.11/html/index.html>`_.
The documentation for the latest release of HPX (currently V0.9.99) can be
`found here <http://stellar.cct.lsu.edu/files/hpx-0.9.99/html/index.html>`_.
In publications this release of HPX can be cited as: |zenodo_doi|.

.. |zenodo_doi| image:: https://zenodo.org/badge/doi/10.5281/zenodo.33656.svg
:target: http://dx.doi.org/10.5281/zenodo.33656
.. |zenodo_doi| image:: https://zenodo.org/badge/doi/10.5281/zenodo.58027.svg
:target: http://dx.doi.org/10.5281/zenodo.58027

Additionally, we regularly upload the current status of the documentation
(which is being worked on as we speak)
`here <http://stellar-group.github.io/hpx/docs/html/>`_. We also have a
single-page version of the documentation `here <http://stellar-group.github.io/hpx/docs/html/hpx.html>`_.

If you plan to use HPX we suggest to start with the latest released version
(currently HPX V0.9.11) which can be `downloaded here <http://stellar.cct.lsu.edu/downloads/>`_.
(currently HPX V0.9.99) which can be `downloaded here <http://stellar.cct.lsu.edu/downloads/>`_.

If you would like to work with the cutting edge version from this repository
we suggest following the current health status of the master branch by looking at
Expand Down Expand Up @@ -125,7 +125,7 @@ Linux
cmake -DBOOST_ROOT=~/packages/boost \
-DHWLOC_ROOT=/packages/hwloc \
-DCMAKE_INSTALL_PREFIX=~/packages/hpx \
~/downloads/hpx_0.9.11
~/downloads/hpx_0.9.99

5) Invoke GNU make. If you are on a machine with multiple cores (very likely),
add the -jN flag to your make invocation, where N is the number of cores
Expand Down Expand Up @@ -181,7 +181,7 @@ OS X (Mac)
cmake -DCMAKE_CXX_COMPILER=/usr/bin/clang++ \
-DBOOST_ROOT=~/packages/boost \
-DCMAKE_INSTALL_PREFIX=~/packages/hpx \
~/downloads/hpx_0.9.11
~/downloads/hpx_0.9.99

5) Invoke GNU make. If you are on a machine with multiple cores (very likely),
add the -jN flag to your make invocation, where N is the number of cores
Expand Down Expand Up @@ -337,55 +337,6 @@ For more detailed information about building HPX for the Xeon/Phi please refer t
the `documentation <http://stellar-group.github.io/hpx/docs/html/hpx/manual/build_system/building_hpx/build_recipes.html#hpx.manual.build_system.building_hpx.build_recipes.intel_mic_installation>`_.



******************
Docker
******************

We also provide several HPX docker images.
Those can be used for rapid prototyping, demonstrations or writing minimal
examples for issue reports. This also provides an HPX build environment for
continuous integration of external projects.

The following images are currently available:

* ``stellargroup/hpx:dev`` (HEAD, updated on every commit to master which
builds successfully, see
`here <https://circleci.com/gh/STEllAR-GROUP/hpx/tree/master>`_ for the
build status)
* ``stellargroup/hpx:latest`` (latest release)
* ``stellargroup/hpx:0.9.11`` (release v0.9.11)
* ``stellargroup/hpx:0.9.10`` (release v0.9.10)

While a more detailed introduction to docker can be found at the official
`docker homepage <https://docs.docker.com/userguide/>`_, here are some easy
steps that explain how to use a docker image::

# Download/Update the image
docker pull stellargroup/hpx:dev

# Run a command.
# NOTICE: Docker images are read-only and will be reset after execution.
docker run stellargroup/hpx:dev hello_world

# Mount a host directory to make changes persistent.
# In this case, mount the current host directory $PWD to /hpx in the
# dockerfile via '-v'.
# Also, make /hpx the current working directory with '-w'.
docker run -v $PWD:/hpx -w /hpx stellargroup/hpx:dev <command> <arguments>

# For example, build the binary "example" from "example.cpp" using
# the built-in hpx compilation script "hpxcxx". Note that hpx libraries
# other than the core library have to be linked explicitly (like hpx_iostreams).
docker run -v $PWD:/hpx -w /hpx stellargroup/hpx:dev \
hpxcxx example.cpp --exe=example -lhpx_iostreams

# Now run the resulting program:
docker run -v $PWD:/hpx -w /hpx stellargroup/hpx:dev ./example




******************
Acknowledgements
******************
Expand Down Expand Up @@ -424,3 +375,7 @@ HPX is currently funded by

* The Bavarian Research Foundation (Bayerische Forschungsstfitung) through
the grant AZ-987-11.

* The European Commission's Horizon 2020 programme through the grant
H2020-EU.1.2.2. 671603 (AllScale).

4 changes: 2 additions & 2 deletions docs/CMakeLists.txt
Expand Up @@ -327,8 +327,8 @@ hpx_quickbook_to_html(hpx
toc.max.depth=4
generate.section.toc.level=4
boost.image.src=${image}
boost.image.w=604
boost.image.h=90
boost.image.w=562
boost.image.h=104
boost.image.alt="HPX"
${auto_index_xsl_param}
QUICKBOOK_ARGS ${quickbook_fixme_mode} ${auto_index_mode}
Expand Down
6 changes: 3 additions & 3 deletions docs/hpx.qbk
Expand Up @@ -11,7 +11,7 @@
[quickbook 1.7]
[id hpx]
[authors [STE||AR Group, The]]
[version 0.9.99]
[version 1.0.0]
[copyright 2011 2012 2013 2014 2015 2016 The STE||AR Group (http://stellar-group.org)]
[license
Distributed under the Boost Software License, Version 1.0. (See
Expand All @@ -37,10 +37,10 @@
[def __0_9_9__ [link hpx.whats_new.hpx_previous.hpx_0_9_9 V0.9.9]]
[def __0_9_10__ [link hpx.whats_new.hpx_previous.hpx_0_9_10 V0.9.10]]
[def __0_9_11__ [link hpx.whats_new.hpx_previous.hpx_0_9_11 V0.9.11]]
[def __0_9_99__ [link hpx.whats_new.hpx_0_9_99 V0.9.99]]
[def __0_9_99__ [link hpx.whats_new.hpx_previous.hpx_0_9_99 V0.9.99]]
[def __1_0_0__ [link hpx.whats_new.hpx_1_0_0 V1.0.0]]

[def __version__ __0_9_99__]
[def __version__ __1_0_0__]

[def __hpx__ /HPX/]
[def __hpx_compute__ /HPX.Compute/]
Expand Down
Binary file modified docs/html/images/hpx_1_0_0.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/html/images/hpx_1_0_0_draft.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 6 additions & 3 deletions docs/people.qbk
Expand Up @@ -11,7 +11,7 @@
The __stellar__ Group (pronounced as stellar) stands for "[*S]ystems [*T]echnology,
[*E]mergent Para[*ll]elism, and [*A]lgorithm [*R]esearch". We are an
international group of faculty, researchers, and students working at various
institutions around the world.
institutions around the world.
The goal of the __stellar__ Group is to promote the development of
scalable parallel applications by providing a community for ideas, a framework
for collaboration, and a platform for communicating these concepts to the
Expand All @@ -26,7 +26,7 @@ to more conventional programming models such as MPI.

__hpx__ is based on /ParalleX/ which is a new
(and still experimental) parallel execution model aiming to
overcome the limitations imposed by the current hardware and the techniques
overcome the limitations imposed by the current hardware and the techniques
we use to write
applications today. Our group focuses on two types of applications - those
requiring excellent strong scaling, allowing for a dramatic reduction of
Expand Down Expand Up @@ -99,6 +99,8 @@ our tables below.
Thanks also to the following people who contributed directly or indirectly to
the project through discussions, pull requests, documentation patches, etc.

* Khalid Hasanov, who contributed changes which allowed to run HPX on 64Bit
power-pc architectures.
* Zahra Khatami, who contributed the prefetching iterators and the persistent
auto chunking executor parameters implementation.
* Marcin Copik, who worked on implementing GPU support for C++AMP and HCC.
Expand Down Expand Up @@ -212,7 +214,8 @@ __hpx__ is currently funded by the following grants:
United States Government or any agency thereof.
* The Bavarian Research Foundation (Bayerische Forschungsstfitung)
through the grant AZ-987-11.

* The European Commission's Horizon 2020 programme through the grant
H2020-EU.1.2.2. 671603 (AllScale).

[endsect] [/ People]

Expand Down
Binary file modified docs/version.pptx
Binary file not shown.