Merge pull request #241 from ldbc/cleanup-and-streamlining

Cleanup introduction, move software components to the relevant chapters

README.md

@@ -10,18 +10,21 @@
 
 For a quick overview of LDBC SNB, start with our [presentation](https://docs.google.com/presentation/d/1NilxSrKQnFq4WzWMY2-OodZQ2TEksKzKBmgB20C_0Nw/) ([PDF](https://ldbcouncil.org/docs/presentations/ldbc-snb-2022-11.pdf)).
 
-For a guide on how to develop SNB Interactive implementations, please check out the README of the [Interactive implementations repository](https://github.com/ldbc/ldbc_snb_interactive_impls).
+For a guide on how to develop SNB Interactive implementations, please check out the READMEs of the reference implementation repositories linked below.
 
-## Compatibility
+## Software components
 
-The two SNB workloads are stored in different repositories:
+The SNB workloads are stored in different repositories:
 
-* Interactive:
-  * Data generator (for versions 0.x and 1.x): https://github.com/ldbc/ldbc_snb_datagen_hadoop
-  * Data generator (for version 2.0): https://github.com/ldbc/ldbc_snb_datagen_spark
-  * Driver: https://github.com/ldbc/ldbc_snb_interactive_driver
-  * Reference implementations: https://github.com/ldbc/ldbc_snb_interactive_impls
-* Business Intelligence (BI):
+* SNB Interactive v1:
+  * Data generator: https://github.com/ldbc/ldbc_snb_datagen_hadoop
+  * Driver: https://github.com/ldbc/ldbc_snb_interactive_v1_driver
+  * Reference implementations: https://github.com/ldbc/ldbc_snb_interactive_v1_impls
+* SNB Interactive v2:
+  * Data generator: https://github.com/ldbc/ldbc_snb_datagen_spark
+  * Driver: https://github.com/ldbc/ldbc_snb_interactive_v2_driver
+  * Reference implementations: https://github.com/ldbc/ldbc_snb_interactive_v2_impls
+* SNB Business Intelligence (BI):
   * Data generator: https://github.com/ldbc/ldbc_snb_datagen_spark
   * Driver and reference implementations: https://github.com/ldbc/ldbc_snb_bi
 

auditing.tex

@@ -621,7 +621,7 @@ \subsection{Full Disclosure Report}
     \item A README file with instructions specifying how to set up the system and run the benchmark
     \item Configuration files of the database, including database-level configuration such as buffer size and schema descriptors (if necessary)
     \item Source code or binary of a generic driver that can be used to interact with the DBMS
-    \item SUT-specific LDBC driver implementation (similarly to the projects in \url{https://github.com/ldbc/ldbc_snb_interactive_impls})
+    \item SUT-specific LDBC driver implementation (similarly to the projects in \url{https://github.com/ldbc/ldbc_snb_interactive_v1_impls}, \url{https://github.com/ldbc/ldbc_snb_interactive_v2_impls}, \url{https://github.com/ldbc/ldbc_snb_bi})
     \item Script or instructions to compile the LDBC Java driver implementation
     \item Instructions on how to the reach the server through CLI and/or web UI (if applicable), \eg the URL (including port number), user name and password
     \item LDBC configuration files (\texttt{.properties}), including the \texttt{time\_compression\_ratio} values used in the audited runs

bi.tex

@@ -7,19 +7,28 @@ \chapter{Business Intelligence Workload}
 (see
 \autoref{sec:bi-insert-operations} for inserts and
 \autoref{sec:bi-delete-operations} for deletes).
-
 % The available batches are
 % 2012-11-29,
 % 2012-11-30,
 % 2012-12-01, \ldots
 % 2012-12-31;
 % yielding 33~batches in total.
 
-
 \subsection*{Related Publications}
 
 The BI workload was published in PVLDB 2022~\cite{DBLP:journals/pvldb/SzarnyasWSSBWZB22}.
 
+\subsection*{Related Software Components}
+
+\begin{itemize}
+    \item Datagen (Spark-based): \url{https://github.com/ldbc/ldbc_snb_datagen_spark}
+    \item Driver and reference implementations: \url{https://github.com/ldbc/ldbc_snb_bi}
+\end{itemize}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \section{Overview}
 \label{sec:bi-benchmark-overview}
 

interactive-v1.tex

@@ -1,7 +1,7 @@
 \chapter{Interactive v1 Workload}
 \label{sec:interactive-v1}
 
-This workload consists of a set of relatively complex read-only queries, that touch a significant
+The Interactive v1 workload consists of a set of relatively complex read-only queries, that touch a significant
 amount of data -- often the two-step friendship neighbourhood and associated messages --, but typically in close proximity to a single node. Hence, the query complexity is sublinear to the dataset size.
 
 The LDBC SNB Interactive workload consists of three query classes:
@@ -19,6 +19,14 @@ \subsection*{Related Publications}
     It is part of this specification in \autoref{sec:acid-test-suite}.
 }
 
+\subsection*{Related Software Components}
+
+\begin{itemize}
+    \item Datagen (Hadoop-based): \url{https://github.com/ldbc/ldbc_snb_datagen_hadoop}
+    \item Driver: \url{https://github.com/ldbc/ldbc_snb_interactive_v1_driver}
+    \item Reference implementations: \url{https://github.com/ldbc/ldbc_snb_interactive_v1_impls}
+\end{itemize}
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

interactive-v2.tex

@@ -12,6 +12,18 @@ \subsection*{Related Publications}
     \item \textbf{Delete operations.} See \autoref{sec:delete-operations}.
 \end{itemize}
 
+\subsection*{Related Software Components}
+
+\begin{itemize}
+    \item Datagen (Spark-based): \url{https://github.com/ldbc/ldbc_snb_datagen_spark}
+    \item Driver: \url{https://github.com/ldbc/ldbc_snb_interactive_v2_driver}
+    \item Reference implementations: \url{https://github.com/ldbc/ldbc_snb_interactive_v2_impls}
+\end{itemize}
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \section{Overview}
 
 \begin{figure}[htb]
@@ -84,7 +96,6 @@ \section{Short reads}
     \input{inserts}
 }
 
-
 \iftoggle{StandaloneWorkloadSpecification}{
     \section{Delete Operations}
     \label{sec:delete-operations}

introduction.tex

@@ -229,55 +229,7 @@ \section{Participation of Industry and Academia}
 of \ldbcsnb is formed by relevant actors from both the industry and academia in
 the field of linked data management. All the participants have contributed with
 their experience and expertise in the field, making a credible and relevant
-benchmark, which meets all the desired needs. The list of participants is the
-following:
-
-\begin{itemize}
-    \item FOUNDATION FOR RESEARCH AND TECHNOLOGY HELLAS
-    \item MTA-BME LENDUELET RESEARCH GROUP ON CYBER-PHYSICAL SYSTEMS
-    \item NEO4J
-    \item ONTOTEXT
-    \item OPENLINK
-    \item TECHNISCHE UNIVERSITAET MUENCHEN
-    \item UNIVERSITAET INNSBRUCK
-    \item UNIVERSITAT POLITECNICA DE CATALUNYA
-    \item VRIJE UNIVERSITEIT AMSTERDAM
-\end{itemize}
-
-\begin{figure}
-\end{figure}
-
-Besides the aforementioned institutions, during the development of the
-benchmark several meetings with the technical and users community have been
-conducted, receiving an invaluable feedback that has contributed to the whole
-development of the benchmark in every of its aspects.
-
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-\section{Software Components}
-
-The source code of this specification and the software components discussed here are available open-source:
-
-\begin{itemize}
-    \item Specification: \url{https://github.com/ldbc/ldbc_snb_docs}
-    \item Interactive workload:
-        \begin{itemize}
-            \item Datagen (Hadoop-based): \url{https://github.com/ldbc/ldbc_snb_datagen_hadoop}
-            \item Driver: \url{https://github.com/ldbc/ldbc_snb_interactive_driver}
-            \item Reference implementations (in Cypher and SQL): \url{https://github.com/ldbc/ldbc_snb_interactive_impls}
-        \end{itemize}
-    \item Business Intelligence (BI) workload:
-        \begin{itemize}
-            \item Datagen (Spark-based): \url{https://github.com/ldbc/ldbc_snb_datagen_spark}
-            \item Driver and reference implementations (in Cypher and SQL): \url{https://github.com/ldbc/ldbc_snb_bi}
-        \end{itemize}
-\end{itemize}
-
-Repositories have two distinguished branches:
-\texttt{stable} contains the code for the v0.3 benchmark, while
-\texttt{dev} contains the code for the v0.4 (work-in-progress) benchmark.
+benchmark, which meets all the desired needs.
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%