typos

README.md

@@ -1,28 +1,28 @@
 # Bwtzip OpenMP
 *A parallel version of the bwtzip project implemented by means of the OpenMP APIs*
 
-In this project the [bwtzip] lossless data compression library from Stephan T. Lavavej was extended by means of [OpenMP] APIs in order to build a faster parallel version of the library.
+In this project, the [bwtzip] lossless data compression library from Stephan T. Lavavej was extended by means of [OpenMP] APIs in order to build a faster parallel version of the library.
 Moreover, a performances analysis was conducted to show to obtained speedup.
 
 **NOTE:** This is neither an official version of the bwtzip project, nor an implementation intended to be distributed.
 
 ## Speedup analysis
 
-Checkout the performed [speedup anlaysis](doc/speedup_analysis) made on the parallel versions of bwtzip
+Check out the performed [speedup analysis](doc/speedup_analysis) made on the parallel versions of bwtzip
 
 - [pbwtzip speedup analysis](doc/speedup_analysis/pbwtzip_speedup_analysis.ipynb)
 - [pbwtzip2 speedup analysis](doc/speedup_analysis/pbwtzip2_speedup_analysis.ipynb)
 
 
 | pbwtzip | pbwtzip2 |  
 |:--------|:---------|
-| ![pbwtzip speedpup linechart](doc/speedup_analysis/images/pbwtzip_speedup_linechart.png) | ![pbwtzip2 speedpup linechart](doc/speedup_analysis/images/pbwtzip2_speedup_linechart.png) |
-| ![pbwtzip speedpup heatmap](doc/speedup_analysis/images/pbwtzip_speedup_heatmap.png) | ![pbwtzip2 speedpup heatmap](doc/speedup_analysis/images/pbwtzip2_speedup_heatmap.png) |
+| ![pbwtzip speedup line chart](doc/speedup_analysis/images/pbwtzip_speedup_linechart.png) | ![pbwtzip2 speedup linechart](doc/speedup_analysis/images/pbwtzip2_speedup_linechart.png) |
+| ![pbwtzip speedup heatmap](doc/speedup_analysis/images/pbwtzip_speedup_heatmap.png) | ![pbwtzip2 speedup heatmap](doc/speedup_analysis/images/pbwtzip2_speedup_heatmap.png) |
 
 
 ## Documentation
 
-Checkout the [documentation](doc) to compile the project and run the speed up analysis!
+Check out the [documentation](doc) to compile the project and run the speed up analysis!
 
 
 ## Project presentation
@@ -35,7 +35,7 @@ By what stated in the Bwtzip official page (<https://nuwen.net/bwtzip.html>)
 
 > *bwtzip is an ongoing project, distributed under the GNU General Public License, to implement a Burrows-Wheeler compressor in standard, portable C++.*
 
-this project inherit the [GNU GPL] license.
+this project inherits the [GNU GPL] license.
 
 ## Source code
 
@@ -52,4 +52,4 @@ This project has been developed for the [Advanced Algorithms and Parallel Progra
 [Parallelization of bwtzip library - Project presentation]: https://docs.google.com/presentation/d/1_zPcOxDOrXDXwXZpeZrBO4OpaLsV2oqjUgEMrGyh-ko
 [GNU GPL]: LICENSE
 [Advanced Algorithms and Parallel Programming course]: https://www4.ceda.polimi.it/manifesti/manifesti/controller/ManifestoPublic.do?EVN_DETTAGLIO_RIGA_MANIFESTO=EVENTO&c_insegn=095946&aa=2017&k_cf=225&k_corso_la=481&ac_ins=0&k_indir=T2A&lang=EN&tipoCorso=ALL_TIPO_CORSO&semestre=2&codDescr=095946&idGruppo=3589&idRiga=216915&jaf_currentWFID=main
-[Politecnico di Milano]: https://www.polimi.it
+[Politecnico di Milano]: https://www.polimi.it

doc/download-datasets.md

@@ -51,7 +51,7 @@ $ ./script/download_large_source_code.sh
 ```
 ---
 
-## Remarks on skip downloads and skip unzipping
+## Remarks on skip download and skip unzipping
 
 The download scripts are designed to skip the download of any resource (file and directory) that is already present on disk.
 

doc/speedup_analysis/pbwtzip2_speedup_analysis.ipynb

@@ -8,7 +8,7 @@
     "\n",
     "## Introduction\n",
     "\n",
-    "The aim of this notebook is to analyze and evaluate the performance improvements obtained through the parallelization of the bwtzip loseless compression algorithm.\n",
+    "The aim of this notebook is to analyze and evaluate the performance improvements obtained through the parallelization of the bwtzip lossless compression algorithm.\n",
     "\n",
     "**pbwtzip2** is the parallel version of the bwtzip library. It has been developed starting from the sequential original code of bwtzip and then parallelized by the use of OpenMP APIs. Moreover, some changes have been made to the code and internal data structures in order to achieve a good parallelization strategy. \n",
     "\n",
@@ -78,16 +78,16 @@
     "\n",
     "Buffers are of size **K per side**. Hence K\\*2 chunks of data are overall stored in the buffer.\n",
     "\n",
-    "At each pipeline iteration every stage withdraw **K** chunks of data from the buffer preceding it and, after performing the functions assigned, it writes them to the buffer after the stage.\n",
+    "At each pipeline iteration every stage withdraws **K** chunks of data from the buffer preceding it and, after performing the functions assigned, it writes them to the buffer after the stage.\n",
     "Only exceptions to this are: \n",
-    " - Reader: only fill the buffer following it with the chunks read from input file\n",
-    " - Writer: only read the buffer preceding it and write compressed data chunks to output file\n",
+    " - Reader: only fill the buffer following it with the chunks read from the input file\n",
+    " - Writer: only read the buffer preceding it and write compressed data chunks to the output file\n",
     "\n",
     "The **k parameter** is defined at runtime based on the thread configuration passed as parameter to pbwtzip.\n",
     "\n",
     "#### Threads configuration\n",
     "\n",
-    "The threads configuration is the parallelization layout that is used by pbwtzip to assign number of threads to the stages, so to run \"multiple instances\" of them in parallel over differen chunks of data.\n",
+    "The threads configuration is the parallelization layout that is used by pbwtzip to assign the number of threads to the stages, so to run \"multiple instances\" of them in parallel over different chunks of data.\n",
     "\n",
     "For example, the thread configuration: `5.2` would assign\n",
     "\n",
@@ -102,12 +102,12 @@
     "\n",
     "## Parameters space\n",
     "\n",
-    "Then, the parameters that can be used to change the pbwtzip exectuon performances are:\n",
+    "Then, the parameters that can be used to change the pbwtzip execution performances are:\n",
     "\n",
     "- chunk size\n",
     "- thread configuration\n",
     "\n",
-    "The below shown comparison will highlight the speedup optained with the parallel version bwtzip with reespect to its sequential version.\n",
+    "The below-shown comparison will highlight the speedup obtained with the parallel version bwtzip with respect to its sequential version.\n",
     "\n",
     "\n",
     "## Speedup computation\n",
@@ -118,11 +118,11 @@
     "\n",
     "**Parallel execution time**\n",
     "\n",
-    "Time required by the parallel algorithm to run on **p processors**   $T_p(n)$\n",
+    "The time required by the parallel algorithm to run on **p processors**   $T_p(n)$\n",
     "\n",
     "\n",
     "## Speedup\n",
-    "Optained speedup on p processors \n",
+    "Obtained speedup on p processors \n",
     "\n",
     "$$Speedup = \\frac{T^*(n)}{T_p(n)}$$\n",
     "\n",

doc/speedup_analysis/pbwtzip_speedup_analysis.ipynb

@@ -8,7 +8,7 @@
     "\n",
     "## Introduction\n",
     "\n",
-    "The aim of this notebook is to analyze and evaluate the performance improvements obtained through the parallelization of the bwtzip loseless compression algorithm.\n",
+    "The aim of this notebook is to analyze and evaluate the performance improvements obtained through the parallelization of the bwtzip lossless compression algorithm.\n",
     "\n",
     "**pbwtzip** is the parallel version of the bwtzip library. It has been developed starting from the sequential original code of bwtzip and then parallelized by the use of OpenMP APIs. Moreover, some changes have been made to the code and internal data structures in order to achieve a good parallelization strategy. \n",
     "\n",
@@ -76,16 +76,16 @@
     "\n",
     "Buffers are of size **K per side**. Hence K\\*2 chunks of data are overall stored in the buffer.\n",
     "\n",
-    "At each pipeline iteration every stage withdraw **K** chunks of data from the buffer preceding it and, after performing the functions assigned, it writes them to the buffer after the stage.\n",
+    "At each pipeline iteration every stage withdraws **K** chunks of data from the buffer preceding it and, after performing the functions assigned, it writes them to the buffer after the stage.\n",
     "Only exceptions to this are: \n",
-    " - Reader: only fill the buffer following it with the chunks read from input file\n",
-    " - Writer: only read the buffer preceding it and write compressed data chunks to output file\n",
+    " - Reader: only fill the buffer following it with the chunks read from the input file\n",
+    " - Writer: only read the buffer preceding it and write compressed data chunks to the output file\n",
     "\n",
     "The **k parameter** is defined at runtime based on the thread configuration passed as parameter to pbwtzip.\n",
     "\n",
     "#### Threads configuration\n",
     "\n",
-    "The threads configuration is the parallelization layout that is used by pbwtzip to assign number of threads to the stages, so to run \"multiple instances\" of them in parallel over differen chunks of data.\n",
+    "The threads configuration is the parallelization layout that is used by pbwtzip to assign number of threads to the stages, so to run \"multiple instances\" of them in parallel over different chunks of data.\n",
     "\n",
     "For example, the thread configuration: `5.2.1` would assign\n",
     "\n",
@@ -101,12 +101,12 @@
     "\n",
     "## Parameters space\n",
     "\n",
-    "Then, the parameters that can be used to change the pbwtzip exectuon performances are:\n",
+    "Then, the parameters that can be used to change the pbwtzip execution performances are:\n",
     "\n",
     "- chunk size\n",
     "- thread configuration\n",
     "\n",
-    "The below shown comparison will highlight the speedup optained with the parallel version bwtzip with reespect to its sequential version.\n",
+    "The below-shown comparison will highlight the speedup obtained with the parallel version bwtzip with respect to its sequential version.\n",
     "\n",
     "\n",
     "## Speedup computation\n",
@@ -117,11 +117,11 @@
     "\n",
     "**Parallel execution time**\n",
     "\n",
-    "Time required by the parallel algorithm to run on **p processors**   $T_p(n)$\n",
+    "The time required by the parallel algorithm to run on **p processors**   $T_p(n)$\n",
     "\n",
     "\n",
     "## Speedup\n",
-    "Optained speedup on p processors \n",
+    "Obtained speedup on p processors \n",
     "\n",
     "$$Speedup = \\frac{T^*(n)}{T_p(n)}$$\n",
     "\n",