From 7a321fa7c5f0cb671a5fadb20822509334627d42 Mon Sep 17 00:00:00 2001 From: Rich Hornung Date: Fri, 30 Aug 2024 12:38:23 -0700 Subject: [PATCH 1/3] Add refs and links to RAJA Perf and a couple other updates. Users find looking at RAJA Perf as a source of RAJA usage examples instructive. Hopefully, these modest changes will help them navigate to that project. --- README.md | 5 ++++- docs/sphinx/user_guide/getting_started.rst | 10 +++++++++- docs/sphinx/user_guide/tutorial.rst | 8 ++++++++ 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index aa42af1a87..27146b1a6c 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,10 @@ The [**RAJA Performance Suite**](https://github.com/LLNL/RAJAPerf) contains a collection of loop kernels implemented in multiple RAJA and non-RAJA variants. We use it to monitor and assess RAJA performance on different platforms using a variety of compilers. Many major compiler vendors use the -Suite to improve their support of abstractions like RAJA. +Suite to improve their support of abstractions like RAJA. **The RAJA +Performance Suite is an excellent source of examples of RAJA usage where you +can compare RAJA and non-RAJA variants of a variety of different kernels and +RAJA back-ends.** The [**RAJA Proxies**](https://github.com/LLNL/RAJAProxies) repository contains RAJA versions of several important HPC proxy applications. diff --git a/docs/sphinx/user_guide/getting_started.rst b/docs/sphinx/user_guide/getting_started.rst index 62196fff00..eb7ed2daa2 100644 --- a/docs/sphinx/user_guide/getting_started.rst +++ b/docs/sphinx/user_guide/getting_started.rst @@ -28,7 +28,7 @@ in :ref:`configopt-label`. To build RAJA and use its most basic features, you will need: - C++ compiler with C++14 support -- `CMake `_ version 3.23 or greater when building the HIP back-end, and version 3.20 or greater otherwise. +- `CMake `_ version 3.23 or greater. ================== @@ -371,3 +371,11 @@ be located in the ``/test`` directory. For an overview of all the main RAJA features, see :ref:`features-label`. A full tutorial with a variety of examples showing how to use RAJA features can be found in :ref:`tutorial-label`. + +.. important:: The `RAJA Performance Suite ` + is an excellent source of RAJA usage examples. The Suite + contains many numerical kernels, each of which is implemented + in a variety of RAJA and non-RAJA variants in OpenMP, CUDA, HIP, + SYCL, etc. Comparing different variants of these kernels is + instructive to understand how to use RAJA features and how they + work. diff --git a/docs/sphinx/user_guide/tutorial.rst b/docs/sphinx/user_guide/tutorial.rst index e153553fc7..e8eea5d9bc 100644 --- a/docs/sphinx/user_guide/tutorial.rst +++ b/docs/sphinx/user_guide/tutorial.rst @@ -449,3 +449,11 @@ Other RAJA Features and Usage Examples tutorial/halo-exchange.rst tutorial/matrix_multiply.rst + +.. important:: The `RAJA Performance Suite ` + is an excellent source of RAJA usage examples. The Suite + contains many numerical kernels, each of which is implemented + in a variety of RAJA and non-RAJA variants in OpenMP, CUDA, HIP, + SYCL, etc. Comparing different variants of these kernels is + instructive to understand how to use RAJA features and how they + work. From 12877a10a041393397cc5219363cb464825e9f73 Mon Sep 17 00:00:00 2001 From: Rich Hornung Date: Fri, 30 Aug 2024 13:20:57 -0700 Subject: [PATCH 2/3] Attempt to add GH Actions status badge --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 27146b1a6c..7d4463ebe6 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,8 @@ # RAJA -[![Azure Pipeline Build Status](https://dev.azure.com/LLNL-RAJA/RAJA/_apis/build/status/LLNL.RAJA?branchName=develop)](https://dev.azure.com/LLNL-RAJA/RAJA/_build/latest?definitionId=1&branchName=develop) +[![GitHub Actions Build and Test](https://github.com/LLNL/RAJA/actions/workflows/build.yml] +[![Azure Pipeline Build and Test](https://dev.azure.com/LLNL-RAJA/RAJA/_apis/build/status/LLNL.RAJA?branchName=develop)](https://dev.azure.com/LLNL-RAJA/RAJA/_build/latest?definitionId=1&branchName=develop) [![Documentation Status](https://readthedocs.org/projects/raja/badge/?version=develop)](https://raja.readthedocs.io/en/develop/?badge=develop) [![Coverage](https://img.shields.io/codecov/c/github/LLNL/RAJA/develop.svg)](https://codecov.io/gh/LLNL/RAJA) [![Join the chat at https://gitter.im/llnl/raja](https://badges.gitter.im/llnl/raja.svg)](https://gitter.im/llnl/raja?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) From 0a2ad30bf8bb387ff234600d5dfcf9ad2663d405 Mon Sep 17 00:00:00 2001 From: Rich Hornung Date: Fri, 30 Aug 2024 13:25:06 -0700 Subject: [PATCH 3/3] Revert "Attempt to add GH Actions status badge" This reverts commit 12877a10a041393397cc5219363cb464825e9f73. --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 7d4463ebe6..27146b1a6c 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,7 @@ # RAJA -[![GitHub Actions Build and Test](https://github.com/LLNL/RAJA/actions/workflows/build.yml] -[![Azure Pipeline Build and Test](https://dev.azure.com/LLNL-RAJA/RAJA/_apis/build/status/LLNL.RAJA?branchName=develop)](https://dev.azure.com/LLNL-RAJA/RAJA/_build/latest?definitionId=1&branchName=develop) +[![Azure Pipeline Build Status](https://dev.azure.com/LLNL-RAJA/RAJA/_apis/build/status/LLNL.RAJA?branchName=develop)](https://dev.azure.com/LLNL-RAJA/RAJA/_build/latest?definitionId=1&branchName=develop) [![Documentation Status](https://readthedocs.org/projects/raja/badge/?version=develop)](https://raja.readthedocs.io/en/develop/?badge=develop) [![Coverage](https://img.shields.io/codecov/c/github/LLNL/RAJA/develop.svg)](https://codecov.io/gh/LLNL/RAJA) [![Join the chat at https://gitter.im/llnl/raja](https://badges.gitter.im/llnl/raja.svg)](https://gitter.im/llnl/raja?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)