[wip] clean

availability_reproducibility_initiative_report.md

@@ -2,42 +2,47 @@
 
 ---
 
-1) **Source Code**
-   - [Source code](/publication/source_code)
-
-2) **Software/Library Dependencies**
-   - __Clang++__
-   - __CMake__ 3.22 or higher
-
-3) **Hardware Requirements**
-   - [Intel Ice Lake](https://en.wikipedia.org/wiki/Ice_Lake_(microprocessor))
-   - [Zen 3](https://en.wikipedia.org/wiki/Zen_3)
-   - [Apple M1](https://en.wikipedia.org/wiki/Apple_M1)
-   - [AWS Graviton 2](https://en.wikipedia.org/wiki/AWS_Graviton)
-   - [AWS Graviton 3](https://en.wikipedia.org/wiki/AWS_Graviton)
-
-4) **Data Collection and Plotting Scripts**
-   - [Plotter](/publication/plotter) collects data and plots all figures in the paper.
-   - Figures are a combination of data already in the repository and additional data produced by running the script.
-   - *Figure 6*: Script missing and needs to be completed.
-   - [Table Drawer](/publication/master_script/draw_table_4.py) generates Table 4 from the paper.
-
-5) **Tables from Experimental Results**
-   - Script also generates tables from experimental results in Markdown format.
-
-6) **Documentation**
-   - Compilation, deployment, execution, and script usage instructions are provided in [BENCHMARKING.md](/BENCHMARKING.md), detailing how to replicate experiments and benchmarks from our [publication](https://dl.acm.org/doi/pdf/10.1145/3626717).
-
-7) **Master Script**
-   - [Single master script](/publication/master_script/master_script.sh) that runs the experiments, collects data, and manages the workflow.
-   - Output includes a log file (`master_script.log`), with a report of completed steps in green, and tables in brown.
-   - On MacBooks, the script needs to be executed with `sudo` access to obtain the cycle counter.
-   - Font warnings do not impact functionality but may require additional font installation.
-
-8) **Deployment and Execution Estimates**
-   - Estimated deployment time and effort: X hours
-   - Execution time for the full workflow (for reviewer preparation): 1 hour
+## 1. Source Code
+- [Source code](/publication/source_code)
+
+## 2. Software/Library Dependencies
+- **Clang++**
+- **CMake** (3.22 or higher)
+- **Boost** (required for end-to-end benchmarks)
+
+## 3. Hardware Requirements
+- [Intel Ice Lake](https://en.wikipedia.org/wiki/Ice_Lake_(microprocessor)) (x86_64, AVX512): We recommend AWS instances like M6i and C6i.
+- [AMD Zen 3](https://en.wikipedia.org/wiki/Zen_3) (x86_64, AVX2): We recommend AWS instances like M6a and C6a.
+- [Apple M1](https://en.wikipedia.org/wiki/Apple_M1)
+- [AWS Graviton 2](https://en.wikipedia.org/wiki/AWS_Graviton) (ARM64, NEON): We recommend AWS instances like M6g, C6g, R6g, and T4g.
+- [AWS Graviton 3](https://en.wikipedia.org/wiki/AWS_Graviton) (ARM64, NEON): We recommend AWS instances like M7g, C7g, and R7g.
+
+> If you have any further questions about hardware recommendations, feel free to ask.
+
+## 4. Data Collection and Plotting Scripts
+- [Plotter](/publication/plotter): Collects data and generates all figures in the paper.
+  - Figures are based on data in the repository and additional data produced by running the script.
+- **Note**: The script for *Figure 6* is missing and needs to be completed.
+- [Table Drawer](/publication/master_script/draw_table_4.py): Generates Table 4 from the paper.
+
+## 5. Tables from Experimental Results
+- The master script also generates experimental result tables in Markdown format.
+
+## 6. Documentation
+- Detailed instructions for compilation, deployment, execution, and script usage are provided in [BENCHMARKING.md](/BENCHMARKING.md).
+- Guidelines explain how to replicate experiments and benchmarks from the [publication](https://dl.acm.org/doi/pdf/10.1145/3626717).
+
+## 7. Master Script
+- [Master script](/publication/master_script/master_script.sh): Automates experiments, data collection, and workflow management.
+- **Outputs**:
+  - A log file (`master_script.log`) with step completion reports (green) and tables (brown).
+- **MacBook Note**: The script requires `sudo` access to enable the cycle counter.
+- **Font Warnings**: May require additional font installation, but do not impact functionality.
+
+## 8. Deployment and Execution Estimates
+- **Deployment time and effort**: X hours
+- **Execution time**: Approximately 1 hour for the full workflow (for reviewer preparation)
 
 ---
 
-Based on [SIGMOD ARΙ Package Requirements and Guidelines](https://docs.google.com/document/d/1_pheZ2p9Nc8qhtcOpNINm7AxFpPpkpC1n60jJdyr-uk/export?format=pdf&attachment=false)
+**Based on**: [SIGMOD ARΙ Package Requirements and Guidelines](https://docs.google.com/document/d/1_pheZ2p9Nc8qhtcOpNINm7AxFpPpkpC1n60jJdyr-uk/export?format=pdf&attachment=false)

publication/master_script/master_script.sh

@@ -118,18 +118,18 @@ else
     git clone --branch "$BRANCH" "$NEW_REPO_URL" "$PED_DIR"
   fi
 
-  green_echo "Navigating to new target directory..."
+  green_echo "Navigating to PED directory..."
   cd "$PED_DIR"
 
-  green_echo "Creating build directory for the new repository..."
+  green_echo "Creating build directory for PED repository..."
   # Create build directory
   mkdir -p "$PED_DIR/build"
 
-  green_echo "Configuring CMake for the new repository..."
+  green_echo "Configuring CMake for PED repository..."
   # Configure CMake for the new repository
   cmake -DCMAKE_TOOLCHAIN_FILE="$TOOLCHAIN_FILE" -S "$PED_DIR" -B "$PED_DIR/build" -DCMAKE_BUILD_TYPE=Release -DCXX=clang++
   if [ $? -ne 0 ]; then
-    red_echo "CMake configuration for the new repository failed."
+    red_echo "CMake configuration for PED repository failed."
     exit 1
   fi