From c02cf6736a15a47937323d88d278890d3f666a0b Mon Sep 17 00:00:00 2001 From: Mohammad Akhlaghi Date: Sat, 7 Dec 2019 03:57:44 +0000 Subject: The Make demo is now broken into multiple slides Until now, there was only one slide, with many boxes and arrows connecting them. It was too complicated to understand for the viewers. With this commit, it is broken up into separate slides, with each box/arrow added on each slide as we progress. This helps clearly show the logic behind all the connections. The LaTeX source of this graph is in the paper that describes the project, I will later bring that source into the slides too (and remove all the extra figures). --- img/make-demo-1-raw.pdf | Bin 0 -> 6489 bytes img/make-demo-10-texsources.pdf | Bin 0 -> 9826 bytes img/make-demo-11-downloadtex.pdf | Bin 0 -> 9986 bytes img/make-demo-12-analysis1tex.pdf | Bin 0 -> 10109 bytes img/make-demo-13-analysis2tex.pdf | Bin 0 -> 10235 bytes img/make-demo-14-analysis3tex.pdf | Bin 0 -> 10501 bytes img/make-demo-15-initializetex.pdf | Bin 0 -> 10650 bytes img/make-demo-16-projectex.pdf | Bin 0 -> 11078 bytes img/make-demo-17-paper.pdf | Bin 0 -> 11266 bytes img/make-demo-2-input1.pdf | Bin 0 -> 7268 bytes img/make-demo-3-out1a.pdf | Bin 0 -> 7504 bytes img/make-demo-4-out3a.pdf | Bin 0 -> 7787 bytes img/make-demo-5-out2a.pdf | Bin 0 -> 8073 bytes img/make-demo-6-out3b.pdf | Bin 0 -> 8305 bytes img/make-demo-7-input2.pdf | Bin 0 -> 8517 bytes img/make-demo-8-out1b.pdf | Bin 0 -> 8764 bytes img/make-demo-9-out2b.pdf | Bin 0 -> 8949 bytes reproducible-paper.tex | 81 ++++++++++++++++++++++++++++++++----- 18 files changed, 70 insertions(+), 11 deletions(-) create mode 100644 img/make-demo-1-raw.pdf create mode 100644 img/make-demo-10-texsources.pdf create mode 100644 img/make-demo-11-downloadtex.pdf create mode 100644 img/make-demo-12-analysis1tex.pdf create mode 100644 img/make-demo-13-analysis2tex.pdf create mode 100644 img/make-demo-14-analysis3tex.pdf create mode 100644 img/make-demo-15-initializetex.pdf create mode 100644 img/make-demo-16-projectex.pdf create mode 100644 img/make-demo-17-paper.pdf create mode 100644 img/make-demo-2-input1.pdf create mode 100644 img/make-demo-3-out1a.pdf create mode 100644 img/make-demo-4-out3a.pdf create mode 100644 img/make-demo-5-out2a.pdf create mode 100644 img/make-demo-6-out3b.pdf create mode 100644 img/make-demo-7-input2.pdf create mode 100644 img/make-demo-8-out1b.pdf create mode 100644 img/make-demo-9-out2b.pdf diff --git a/img/make-demo-1-raw.pdf b/img/make-demo-1-raw.pdf new file mode 100644 index 0000000..ec9530b Binary files /dev/null and b/img/make-demo-1-raw.pdf differ diff --git a/img/make-demo-10-texsources.pdf b/img/make-demo-10-texsources.pdf new file mode 100644 index 0000000..9a57969 Binary files /dev/null and b/img/make-demo-10-texsources.pdf differ diff --git a/img/make-demo-11-downloadtex.pdf b/img/make-demo-11-downloadtex.pdf new file mode 100644 index 0000000..4277da7 Binary files /dev/null and b/img/make-demo-11-downloadtex.pdf differ diff --git a/img/make-demo-12-analysis1tex.pdf b/img/make-demo-12-analysis1tex.pdf new file mode 100644 index 0000000..46c75cb Binary files /dev/null and b/img/make-demo-12-analysis1tex.pdf differ diff --git a/img/make-demo-13-analysis2tex.pdf b/img/make-demo-13-analysis2tex.pdf new file mode 100644 index 0000000..38188d8 Binary files /dev/null and b/img/make-demo-13-analysis2tex.pdf differ diff --git a/img/make-demo-14-analysis3tex.pdf b/img/make-demo-14-analysis3tex.pdf new file mode 100644 index 0000000..a71a3ca Binary files /dev/null and b/img/make-demo-14-analysis3tex.pdf differ diff --git a/img/make-demo-15-initializetex.pdf b/img/make-demo-15-initializetex.pdf new file mode 100644 index 0000000..bc2570a Binary files /dev/null and b/img/make-demo-15-initializetex.pdf differ diff --git a/img/make-demo-16-projectex.pdf b/img/make-demo-16-projectex.pdf new file mode 100644 index 0000000..0d46859 Binary files /dev/null and b/img/make-demo-16-projectex.pdf differ diff --git a/img/make-demo-17-paper.pdf b/img/make-demo-17-paper.pdf new file mode 100644 index 0000000..888b299 Binary files /dev/null and b/img/make-demo-17-paper.pdf differ diff --git a/img/make-demo-2-input1.pdf b/img/make-demo-2-input1.pdf new file mode 100644 index 0000000..9b342fd Binary files /dev/null and b/img/make-demo-2-input1.pdf differ diff --git a/img/make-demo-3-out1a.pdf b/img/make-demo-3-out1a.pdf new file mode 100644 index 0000000..92189ad Binary files /dev/null and b/img/make-demo-3-out1a.pdf differ diff --git a/img/make-demo-4-out3a.pdf b/img/make-demo-4-out3a.pdf new file mode 100644 index 0000000..0f25649 Binary files /dev/null and b/img/make-demo-4-out3a.pdf differ diff --git a/img/make-demo-5-out2a.pdf b/img/make-demo-5-out2a.pdf new file mode 100644 index 0000000..52f0599 Binary files /dev/null and b/img/make-demo-5-out2a.pdf differ diff --git a/img/make-demo-6-out3b.pdf b/img/make-demo-6-out3b.pdf new file mode 100644 index 0000000..c429d6b Binary files /dev/null and b/img/make-demo-6-out3b.pdf differ diff --git a/img/make-demo-7-input2.pdf b/img/make-demo-7-input2.pdf new file mode 100644 index 0000000..aff99d9 Binary files /dev/null and b/img/make-demo-7-input2.pdf differ diff --git a/img/make-demo-8-out1b.pdf b/img/make-demo-8-out1b.pdf new file mode 100644 index 0000000..fe6f123 Binary files /dev/null and b/img/make-demo-8-out1b.pdf differ diff --git a/img/make-demo-9-out2b.pdf b/img/make-demo-9-out2b.pdf new file mode 100644 index 0000000..b25a4ea Binary files /dev/null and b/img/make-demo-9-out2b.pdf differ diff --git a/reproducible-paper.tex b/reproducible-paper.tex index 9543f6e..8cebe7b 100644 --- a/reproducible-paper.tex +++ b/reproducible-paper.tex @@ -101,7 +101,15 @@ top color=white, bottom color=green!50!black!20 } } - +%% For the make demo +\newcommand{\makedemoslide}[2] { + \begin{frame}{#2} + \begin{center}\includegraphics[width=0.8\linewidth]{#1}\end{center} + \footnotesize \textcolor{green!50!black}{Green boxes} are \emph{source} + files (hand-written), \textcolor{blue}{Blue boxes} are \emph{built} + files (automatically generated). + \end{frame} + } @@ -883,10 +891,41 @@ - \begin{frame}{With Make, we can record the full data lineage} - \centering - \includegraphics[width=0.8\linewidth]{img/analysis-diagram.pdf} - \end{frame} + %% Make demo. + \makedemoslide{img/make-demo-1-raw.pdf} + {Source files (containing instructions and configuration parameters).} + \makedemoslide{img/make-demo-2-input1.pdf} + {First built/output file (downloaded dataset).} + \makedemoslide{img/make-demo-3-out1a.pdf} + {Downloaded file is used to build analysis-1's first output.} + \makedemoslide{img/make-demo-4-out3a.pdf} + {Second built file is for analysis-3, also depends on + a value in a configuration file.} + \makedemoslide{img/make-demo-5-out2a.pdf} + {First input is also used to build another file (using + two configuration parameters).} + \makedemoslide{img/make-demo-6-out3b.pdf} + {\texttt{out-bb.dat} is built after \texttt{out-2a.dat}.} + \makedemoslide{img/make-demo-7-input2.pdf} + {We now need a second input file, which is downloaded.} + \makedemoslide{img/make-demo-8-out1b.pdf} + {\texttt{out-1b.dat} depends on \texttt{out-1a.dat}, + \texttt{input2.dat} and \texttt{param-1.conf}.} + \makedemoslide{img/make-demo-9-out2b.pdf} + {SUMMARY: The exact lineage of data is thus recorded in Makefiles.} + + + + + + + + + + + + + @@ -959,12 +998,32 @@ \end{center} \end{frame} - \begin{frame}{We have the full data lineage (raw input $\rightarrow$ every number and plot in paper's PDF)} - \centering - \includegraphics[width=0.8\linewidth]{img/analysis-diagram.pdf} - \end{frame} - - + \makedemoslide{img/make-demo-9-out2b.pdf} + {Recall that the data lineage was already recorded in Makefiles.} + \makedemoslide{img/make-demo-10-texsources.pdf} + {Makefiles are also used to connect the analysis with with paper.} + \makedemoslide{img/make-demo-11-downloadtex.pdf} + {Information from the raw inputs is stored in \texttt{download.tex}.} + \makedemoslide{img/make-demo-12-analysis1tex.pdf} + {Values to report from the first analysis step are kept in + \texttt{analysis1.tex}.} + \makedemoslide{img/make-demo-13-analysis2tex.pdf} + {Values to report from the second analysis step are kept in + \texttt{analysis2.tex}.} + \makedemoslide{img/make-demo-14-analysis3tex.pdf} + {Values to report from the third analysis step are kept in + \texttt{analysis3.tex}.} + \makedemoslide{img/make-demo-15-initializetex.pdf} + {General project information are stored in \texttt{initialize.tex}.} + \makedemoslide{img/make-demo-16-projectex.pdf} + {All the \TeX{} macros are loaded into the single + \texttt{project.tex} (after the analysis is complete).} + \makedemoslide{img/make-demo-17-paper.pdf} + {With the paper's \LaTeX{} source, \texttt{project.tex} is + used to build the final PDF paper.} + \makedemoslide{img/make-demo-17-paper.pdf} + {Full data lineage (raw input $\leftrightarrow$ every + number/paragraph and plot in paper's PDF) is recorded.} -- cgit v1.2.1