Add Readme for the new patterns

hpc-io · Nov 6, 2023 · 911c654 · 911c654
1 parent 783bd66
commit 911c654
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 0 deletions.
diff --git a/h5bench_patterns/README.md b/h5bench_patterns/README.md
@@ -0,0 +1,37 @@
+## Additions to H5Bench_read
+4 new patterns are added to the h5bench read benchmark:
+1. CS: Refers to the Cross Stencil data access pattern. A block of fixed sides is used to read data from hdf. This block is given a fixed stride in each dimension and data till end of file is read.
+2. LDC: Refers to the Left Diagonal Corner data access pattern. Data is read from two identical blocks of fixed sides, one in the top left corner and the other in the bottom right corner in the 2D hdf file
+3. RDC: Refers to the Right Diagonal Corner data access pattern. Data is read from two identical blocks of fixed sides, one in the top right corner and the other in the bottom left corner in the 2D hdf file
+4. PRL: Refers to the Peripheral data access pattern. Data is read from the periphery of the file, which is a frame of fixed width and height around the file.
+
+Illustrations of the patterns are given in the table below: 
+
+| Pattern -> | CS | LDC | RDC | PRL |  
+| ---------- | ---------- | ---------- | ---------- | ---------- |  
+|Illustration | ![CS Pattern](./images/CS.png) | ![LDC Pattern](./images/LDC.png) | ![RDC Pattern](./images/RDC.png) | ![PRL Pattern](./images/PRL.png) |  
+
+
+
+Steps for running these benchmarks are the same as the other benchmarks. Besides other parameters, the following parameters are required to be provided in the configuration:
+1. CS  
+    | Parameter | Description |  
+    | --------- | ----------- |  
+    | `BLOCK_SIZE` | Size of the block of data along `dim_1` |  
+    | `BLOCK_SIZE_2` | Size of the block of data along `dim_2` |  
+    | `STRIDE_SIZE` | Size of the block of data along `dim_1` |  
+    | `STRIDE_SIZE_2` | Size of the block of data along `dim_2` |  
+
+2. LDC/RDC
+    | Parameter | Description |  
+    | --------- | ----------- |  
+    | `BLOCK_SIZE` | Size of the block of data along `dim_1` |  
+    | `BLOCK_SIZE_2` | Size of the block of data along `dim_2` |  
+
+3. PRL  
+    | Parameter | Description |  
+    | --------- | ----------- |  
+    | `BLOCK_SIZE` | Size of the frame along `dim_1` |  
+    | `BLOCK_SIZE_2` | Size of the frame along `dim_2` |  
+
+Exmaples of some configurations are provided in `h5bench/samples/sync-write-1d-contig-contig-read-<pattern>.json`
diff --git a/h5bench_patterns/images/CS.png b/h5bench_patterns/images/CS.png
diff --git a/h5bench_patterns/images/LDC.png b/h5bench_patterns/images/LDC.png
diff --git a/h5bench_patterns/images/PRL.png b/h5bench_patterns/images/PRL.png
diff --git a/h5bench_patterns/images/RDC.png b/h5bench_patterns/images/RDC.png