Merge pull request #59 from LLNL/task/rhornung67/fix-readme-links

Proofread pass

Author: artv3

Intro_Tutorial/README.md

@@ -1,15 +1,17 @@
 # RAJA Portability Suite Intro Tutorial
 
-Welcome to the RAJA Portability Suite Intro tutorial. In this tutorial you will learn
-how to write an simple application that can target different hardware
-architectures using the RAJA and Umpire libraries.
+Welcome to the RAJA Portability Suite Intro tutorial. In this tutorial, you
+will learn how to use RAJA and Umpire to write simple platform portable code
+that can be compiled to target different hardware architectures.
 
 ## Lessons
 
-You can find lessons in the lessons subdirectory. Each lesson has a README file
-which will introduce new concepts and provide instructions to move forward. 
-
-Each lesson builds upon the previous one, so if you get stuck, you can look at
-the next lesson to see the complete code. Additionally, some tutorials have
-solutions folder with a provided solution.
+Lessons are in the `lessons` subdirectory. Each lesson has a README file
+that introduces new concepts and provides instructions to complete the lesson.
+Each lesson builds on the previous ones to allow you to practice using RAJA
+and Umpire capabilities and to reinforce the content.
 
+Lessons contain source files with missing code and instructions for you to fill
+in the missing parts along with solution files that contain the completed 
+lesson code. If you get stuck, you can diff the lesson and solution files to see
+the code that the lesson is asking you to fill in.

Intro_Tutorial/lessons/01_blt_cmake/README.md

@@ -1,45 +1,48 @@
-# Lesson 1
+# Lesson 1: BLT and CMake
 
-In this lesson you will learn how to use BLT and CMake to build an executable.
+In this lesson, you will learn how to use BLT and CMake to configure a 
+software project to build. RAJA and Umpire use BLT and CMake as their build
+systems, and so does this tutorial. 
 
-RAJA and Umpire use BLT and CMake as their build systems, and we recommend them
-for other applications, like this tutorial! CMake uses information in a set of
-CMakeLists.txt files to generate files to build your project. In this case, 
-we will be using the `make` program to actually compile everything.
+[CMake](https://cmake.org/) is a common tool for building C++ projects and is
+used throughout the world. It uses information in `CMakeLists.txt` files located in a software project to generate configuration files to build a code project 
+on a particular system. Then, a utility like `make` can be used to compile
+the code.
 
-BLT provides a set of CMake macros that make it easy to write CMake code for HPC
-applications targetting multiple hardware architectures.
+[BLT](https://github.com/LLNL/blt) provides a foundation of CMake macros and 
+other tools that simplify the process of Building, Linking, and Testing high
+performance computing (HPC) applications. In particular, BLT establishes best
+practices for using CMake. 
 
-We won't give you a full CMake/BLT tutorial here, just enough to get things moving.
+The goal with this lesson is not to give you a full CMake/BLT tutorial. We
+want to give you enough information to help get you started configuring and 
+building the code in this tutorial.
 
-Our top-level CMakeLists.txt file describes the project, sets up some options, 
-and then calls `add_subdirectory` so that CMake looks for more CMakeLists.txt 
-files.
+Our top-level [CMakeLists.txt file](https://github.com/LLNL/raja-suite-tutorial/blob/main/CMakeLists.txt)  describes this project, sets some options, 
+and then calls `add_subdirectory`, telling CMake to look in sub-directories for
+more CMakeLists.txt files.
 
-https://github.com/LLNL/raja-suite-tutorial/blob/main/CMakeLists.txt
-
-In this lesson directory, we have a CMakeLists.txt file that will describe our
+In this lesson directory, we have a CMakeLists.txt file that describes our
 application. We use the `blt_add_executable` macro to do this.
 
-The macro takes two (or more) arguments, and the two we care about at the moment
-are `NAME` where you provide the executable name, and `SOURCES` where you list
-all the source code files that make up your application:
+The macro takes two (or more) arguments, and the two most important
+are `NAME` where you provide the name of the executable to be generated, and
+`SOURCES` where you list all the source code files to compile to generate the
+executable:
 
 ```
 blt_add_executable(
     NAME 01_blt_cmake
     SOURCES 01_blt_cmake.cpp)
 ```
 
-For now, we have filled these out for you, but in later lessons you will need to
-make some edits yourself.
-
-For a full tutorial on BLT, please see: https://llnl-blt.readthedocs.io/en/develop/tutorial/index.html
+For more information on BLT, please refer to the [BLT User Guide and Tutorial](https://llnl-blt.readthedocs.io/en/develop/tutorial/index.html).
 
 ## Building the Lessons 
 
-We have already run CMake for you in this container to generate the make-based
-build system. So now you can compile and run the first lesson.
+We have already run CMake for you in the container used for this tutorial
+to generate the make-based build system. So you are ready to compile and run
+the first lesson.
 
 First, open the VSCode terminal (Shift + ^ + `), and then move to the
 build directory:
@@ -49,7 +52,7 @@ $ cd build
 ```
 
 Compiling your project in a different directory than the source code is a best
-practice when using CMake.  Once you are in the build directory, you can use the
+practice when using CMake. Once you are in the build directory, you can use the
 `make` command to compile the executable:
 
 ```
@@ -65,5 +68,4 @@ Hello, world!
 ```
 
 In the next lesson, we will show you how to add RAJA and Umpire as dependencies
-to the application.
-
+to an application.

Intro_Tutorial/lessons/02_raja_umpire/README.md

@@ -1,18 +1,14 @@
-# Lesson 2
+# Lesson 2: RAJA and Umpire as Build Dependencies
 
 In this lesson, you will learn how to add RAJA and Umpire as dependencies 
 to your application.
 
-Like the previous lesson, we have a CMakeLists.txt file that will describe our
-application using the `blt_add_executable` macro.
+RAJA and Umpire are included in this project as **targets** that we tell CMake
+our application depends on: [RAJA and Umpire Depend](https://github.com/LLNL/raja-suite-tutorial/blob/main/tpl/CMakeLists.txt).
 
-RAJA and Umpire are included in this project (look at tpl/CMakeLists.txt) and so
-they exist as "targets" that we can tell CMake our application depends on.
-Additionally, since we have configured this project to use CUDA, BLT provides a
-`cuda` target to ensure that executables will be built with CUDA support.
-
-The `blt_add_executable` macro has another argument, `DEPENDS_ON`, that you can
-use to list dependencies.
+Additionally, we can specify other dependency targets, such as CUDA, in the
+`blt_add_executable` macro for our application executable. The macro has
+an argument for this, `DEPENDS_ON`, that you can use to list dependencies.
 
 ```
 blt_add_executable(
@@ -21,9 +17,11 @@ blt_add_executable(
     DEPENDS_ON )
 ```
 
-Once you have added the dependencies, uncomment out the RAJA and Umpire header
-includes in the source code. Then, you can build and run the lesson as
-before. As a reminder, open the VSCode terminal (Shift + ^ + `), and then 
+In the `CMakeLists.txt` file in this lesson, you will find a `TODO:` comment
+asking you to add the RAJA, umpire, and cuda dependencies to build the lesson 
+code. After you have added the dependencies, uncomment the RAJA and Umpire
+header file includes in the source code. Then, you can build and run the lesson.
+As a reminder, open the VSCode terminal (Shift + ^ + `), and then
 move to the build directory: 
 
 ```

Intro_Tutorial/lessons/03_umpire_allocator/03_umpire_allocator.cpp

@@ -3,8 +3,12 @@
 #include "RAJA/RAJA.hpp"
 #include "umpire/Umpire.hpp"
 
+// TODO: Uncomment this in order to build!
+//#define COMPILE
+
 int main()
 {
+#if defined(COMPILE)
   double* data{nullptr};
 
   // TODO: allocate an array of 100 doubles using the HOST allocator
@@ -18,5 +22,6 @@ int main()
 
   // TODO: deallocate the array
 
+#endif
   return 0;
 }

Intro_Tutorial/lessons/03_umpire_allocator/README.md

@@ -1,47 +1,46 @@
-# Lesson 3
+# Lesson 3: Umpire Allocators
 
 In this lesson, you will learn how to use Umpire to allocate memory. The file
-`03_umpire_allocator.cpp` contains some `TODO:` comments where you can add code to allocate and
-deallocate memory.
+`03_umpire_allocator.cpp` contains `TODO:` comments where you will code to
+allocate and deallocate memory.
 
 The fundamental concept for accessing memory through Umpire is the
 `umpire::Allocator`. An `umpire::Allocator` is a C++ object that can be used to
 allocate and deallocate memory, as well as query a pointer to get
-information about it. (Note: in this lesson, we will see how to query the name of the Allocator!)
+information about it. In this lesson, we will see how to query the name of an Allocator.
 
-All `umpire::Allocator` objects are created and managed by Umpire’s
-`umpire::ResourceManager`. To create an allocator, first obtain a handle to the
-ResourceManager, and then request the Allocator corresponding to the desired
-memory resource using the `getAllocator` function:
+All `umpire::Allocator` objects are created and managed by the
+`umpire::ResourceManager` *Singleton* object. To create an allocator,
+first obtain a handle to the ResourceManager, and then request the Allocator
+corresponding to the desired memory resource using the `getAllocator` function:
 
 ```
 auto& rm = umpire::ResourceManager::getInstance();
 auto allocator = rm.getAllocator("HOST");
 ```
 
 The Allocator class provides methods for allocating and deallocating memory. You
-can view these methods in the Umpire source code documentation here:
-https://umpire.readthedocs.io/en/develop/doxygen/html/classumpire_1_1Allocator.html
+can view these methods in the [Umpire AllocatorInterface](https://umpire.readthedocs.io/en/develop/doxygen/html/classumpire_1_1Allocator.html).
 
-To use an Umpire allocator, use the following code, replacing "size in bytes" with
-the desired size for your allocation:
+To use an Umpire allocator, use the following code, replacing "size in bytes"
+with the desired size for your allocation:
 
 ```
 void* memory = allocator.allocate(size in bytes);
 ```
 
-Moving and modifying data in a heterogenous memory system can be annoying since you 
-have to keep track of the source and destination, and often use vendor-specific APIs 
-to perform the modifications. In Umpire, all data modification and movement, regardless
-of memory resource or platform, is done using Operations. 
+Moving and modifying data in a heterogenous memory system can be subtle
+because you have to keep track of the source and destination memory spaces,
+and often use vendor-specific APIs to perform the modifications. In Umpire,
+all data modification and movement, regardless of memory resource or platform,
+is done using **Umpire Operations**.
 
-Next, we will use the `memset` Operator provided by Umpire's Resource Manager to
-set the memory we just allocated to zero.
+Next, we will use the `memset` Operator provided by Umpire's Resource Manager
+to set the memory we just allocated to zero.
 
 Don't forget to deallocate your memory afterwards!
 
-For more details, you can check out the Umpire documentation:
-https://umpire.readthedocs.io/en/develop/sphinx/tutorial/allocators.html
+For more details, you can check out the [Umpire Allocator Documentation](https://umpire.readthedocs.io/en/develop/sphinx/tutorial/allocators.html).
 
 Once you have made your changes, you can compile and run the lesson:
 

Intro_Tutorial/lessons/03_umpire_allocator/solution/03_umpire_allocator_solution.cpp

@@ -3,8 +3,12 @@
 #include "RAJA/RAJA.hpp"
 #include "umpire/Umpire.hpp"
 
+// TODO: Uncomment this in order to build!
+#define COMPILE
+
 int main()
 {
+#if defined(COMPILE)
   double* data{nullptr};
 
   // TODO: allocate an array of 100 doubles using the HOST allocator
@@ -23,5 +27,6 @@ int main()
   // TODO: deallocate the array
   allocator.deallocate(data);
 
+#endif
   return 0;
 }

Intro_Tutorial/lessons/04_raja_forall/README.md

@@ -1,4 +1,4 @@
-# Lesson Four
+# Lesson 4: RAJA Simple Loops
 
 Data parallel kernels are common in many parallel HPC applications. In a data
 parallel loop kernel, the processing of data that occurs at each iterate **is

Intro_Tutorial/lessons/05_raja_reduce/README.md

@@ -1,4 +1,4 @@
-# Lesson 5
+# Lesson 5: RAJA Reductions 
 
 In lesson 4, we looked at a data parallel loop kernel in which each loop
 iterate was independent of the others. In this lesson, we consider a kernel 

Intro_Tutorial/lessons/06_raja_umpire_host_device/README.md

@@ -1,4 +1,4 @@
-# Lesson 6
+# Lesson 6: Host-Device Memory and Device Kernels
 
 Now, let's learn about Umpire's different memory resources and, in
 particular, those used to allocate memory on a GPU. 

Intro_Tutorial/lessons/07_raja_algs/README.md

@@ -1,4 +1,4 @@
-# Lesson 07
+# Lesson 7: RAJA Algorithms
 
 So far, we've looked at RAJA kernel launch methods, where a user passes a kernel
 body that defines what an algorithm does at each iterate. RAJA provides
@@ -87,6 +87,9 @@ $ make 07_raja_atomic
 $ .bin/07_raja_atomic
 ```
 
+Additional information about RAJA atomic operation support can be found in
+[RAJA Atomic Operations](https://raja.readthedocs.io/en/develop/sphinx/user_guide/tutorial/atomic_histogram.html).
+
 ## Parallel Scan
 
 A **scan operation** is an important building block for parallel algorithms. It
@@ -204,3 +207,6 @@ $ .bin/07_raja_scan
 
 Is the result what you expected it to be? Can you explain why the first value
 in the output is what it is?
+
+Additional information about RAJA scan operations can be found in
+[RAJA Parallel Scan Operations](https://raja.readthedocs.io/en/develop/sphinx/user_guide/tutorial/scan.html).