diff options
| -rw-r--r-- | Makefile | 35 | ||||
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | maneage-introduction.tex (renamed from reproducible-paper.tex) | 56 | ||||
| -rw-r--r-- | tex/git-branch.tex | 24 | ||||
| -rw-r--r-- | tex/project-graph.tex | 27 |
5 files changed, 79 insertions, 73 deletions
@@ -1,29 +1,34 @@ # Automatically build the slides on the reproducible paper # -# Copyright (C) 2018-2019 Mohammad Akhlaghi <mohammad@akhlaghi.org> +# Copyright (C) 2018-2020 Mohammad Akhlaghi <mohammad@akhlaghi.org> # -# This Makefile is free software: you can redistribute it and/or -# modify it under the terms of the GNU General Public License as -# published by the Free Software Foundation, either version 3 of the -# License, or (at your option) any later version. +# This Makefile is part of Maneage. Maneage is free software: you can +# redistribute it and/or modify it under the terms of the GNU General +# Public License as published by the Free Software Foundation, either +# version 3 of the License, or (at your option) any later version. # -# This Makefile is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this Makefile. If not, see <https://www.gnu.org/licenses/>. +# Maneage is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +# more details. See <http://www.gnu.org/licenses/>. + + + + # PDF slides: -reproducible-paper.pdf: reproducible-paper.tex tex/*.tex +maneage-introduction.pdf: maneage-introduction.tex tex/*.tex # We'll run pdflatex two times so the page numbers and # internal links also work. if [ -d .git ]; then v=$$(git describe --dirty --always --long); \ else v=NO-GIT; fi; \ echo "\newcommand{\gitcommit}{$$v}" > git-commit.tex - pdflatex reproducible-paper -# pdflatex reproducible-paper + pdflatex maneage-introduction +# pdflatex maneage-introduction + + + + # Clean all extra files .PHONY: clean-latex clean @@ -1,13 +1,13 @@ -Slides to introduce the reproducible paper template +Slides to introduce Maneage (managing data lineage) =================================================== Copyright (C) 2018-2020 Mohammad Akhlaghi <mohammad@akhlaghi.org>\ See the end of the file for license conditions. -This is the LaTeX source of the slides presenting the [Reproducible -paper template](https://gitlab.com/makhlaghi/reproducible-paper). The -most recent version of the slides is available at -https://akhlaghi.org/pdf/reproducible-paper.pdf . +This is the LaTeX source of the slides presenting +[Maneage](https://gitlab.com/maneage/project). The most recent version +of the slides is available at +https://akhlaghi.org/pdf/maneage-introduction.pdf . To build the slides, you need to have the Beamer and Tikz LaTeX packages installed, then simply run this command. diff --git a/reproducible-paper.tex b/maneage-introduction.tex index a8209c1..6df730b 100644 --- a/reproducible-paper.tex +++ b/maneage-introduction.tex @@ -35,7 +35,7 @@ %% Set the title \title{\huge\textbf{BIG} Data, \textbf{BIG} responsibility - \\ {\normalsize (Reproducible paper template for research data management)}} + \\ {\normalsize Introducing \emph{Maneage}: customizable framework for \emph{man}aging data lin\emph{eage}}} %% Set the author \author{\vspace{1cm}\\ @@ -46,10 +46,10 @@ %% Set the date and insitutional logos. \date{\footnotesize\vspace{0cm}\\ - \href{https://www.rd-alliance.org/groups/exposing-data-management-plans-wg}{RDA Exposing Data Management Plans Working group}\\March 5th, 2020 \\ + \textcolor{white}{PLACE HOLDER}\\\textcolor{white}{MONTH DAY, YEAR} \\ \tiny\vspace{3mm} - Most recent slides available in link below (this PDF is built from \href{https://gitlab.com/makhlaghi/reproducible-paper-slides}{Git commit} \gitcommit):\\ - \footnotesize\textcolor{blue}{\url{http://akhlaghi.org/pdf/reproducible-paper.pdf}}\\ + Most recent slides available in link below (this PDF is built from \href{https://gitlab.com/maneage/slides-introduction}{Git commit} \gitcommit):\\ + \footnotesize\textcolor{blue}{\url{http://akhlaghi.org/pdf/maneage-introduction.pdf}}\\ \vspace{2mm}\hspace{-0.25cm} \raisebox{+0.4\height}{\includegraphics[width=2.5cm]{img/ministerio-ciencia.png}} \raisebox{+0.3\height}{\includegraphics[width=1.3cm]{img/sundial.png}} @@ -537,7 +537,7 @@ \item \emph{Containers} or \emph{Virtual Machines} are a \alert{binary black box}. - \item This template \alert{installs fixed versions} of all + \item Maneage \alert{installs fixed versions} of all necessary research software and their dependencies. \item Installs similar environment on \alert{GNU/Linux}, or @@ -576,7 +576,7 @@ \item \emph{Containers} or \emph{Virtual Machines} are a \alert{binary black box}. - \item This template \alert{installs fixed versions} of all + \item Maneage \alert{installs fixed versions} of all necessary research software and their dependencies. \item Installs similar environment on \alert{GNU/Linux}, or @@ -837,7 +837,7 @@ - \begin{frame}{Reproducible science: Template is managed through a Makefile} + \begin{frame}{Reproducible science: Maneage is managed through a Makefile} \small \begin{columns} \column{10cm} @@ -870,7 +870,7 @@ \includegraphics[width=\linewidth]{img/reproducible-makefile.png} \end{columns} \end{frame} - \begin{frame}{Reproducible science: Template is managed through a Makefile} + \begin{frame}{Reproducible science: Maneage is managed through a Makefile} \small \begin{columns} \column{10cm} @@ -903,7 +903,7 @@ \includegraphics[width=\linewidth]{img/reproducible-makefile-highlighted-1.png} \end{columns} \end{frame} - \begin{frame}{Reproducible science: Template is managed through a Makefile} + \begin{frame}{Reproducible science: Maneage is managed through a Makefile} \small \begin{columns} \column{10cm} @@ -1161,21 +1161,21 @@ - \begin{frame}{New projects branch from template} \include{tex/git-branch} \end{frame} + \begin{frame}{New projects branch from Maneage} \include{tex/git-branch} \end{frame} \newcommand{\projinit}{} - \begin{frame}{New projects branch from template} \include{tex/git-branch} \end{frame} + \begin{frame}{New projects branch from Maneage} \include{tex/git-branch} \end{frame} \newcommand{\projwork}{} - \begin{frame}{New projects branch from template} \include{tex/git-branch} \end{frame} + \begin{frame}{New projects branch from Maneage} \include{tex/git-branch} \end{frame} \newcommand{\tempevolve}{} - \begin{frame}{New projects branch from template} \include{tex/git-branch} \end{frame} + \begin{frame}{New projects branch from Maneage} \include{tex/git-branch} \end{frame} \newcommand{\mergewithtemp}{} - \begin{frame}{New projects branch from template} \include{tex/git-branch} \end{frame} + \begin{frame}{New projects branch from Maneage} \include{tex/git-branch} \end{frame} \newcommand{\tofuture}{} - \begin{frame}{New projects branch from template} \include{tex/git-branch} \end{frame} + \begin{frame}{New projects branch from Maneage} \include{tex/git-branch} \end{frame} \newcommand{\githappy}{} - \begin{frame}{New projects branch from template} \include{tex/git-branch} \end{frame} + \begin{frame}{New projects branch from Maneage} \include{tex/git-branch} \end{frame} \newcommand{\gitverified}{} - \begin{frame}{New projects branch from template} \include{tex/git-branch} \end{frame} + \begin{frame}{New projects branch from Maneage} \include{tex/git-branch} \end{frame} \begin{frame}{Two recent examples (publishing Git checksum in abstract)} \begin{columns} @@ -1205,7 +1205,7 @@ \begin{frame}{Publication of the project} - A reproducible project using this template will have the following + A reproducible project using Maneage will have the following (\alert{plain text}) components: \begin{itemize} \item Makefiles. @@ -1217,7 +1217,7 @@ \alert{negligible} compared to a single figure in a paper (usually $\sim100$ kilo-bytes). - \vspace{1cm} The project's pipeline (customized template) can be + \vspace{1cm} The project's pipeline (customized Maneage) can be \alert{published} in \begin{itemize} \item \alert{arXiv}: uploaded with the \LaTeX{} source to always @@ -1308,14 +1308,14 @@ - \begin{frame}{RDA adoption grant (2019) to IAC for this template} + \begin{frame}{RDA adoption grant (2019) to IAC for Maneage} \begin{center} \includegraphics[width=3cm]{img/rda.png}\hspace{1cm} \includegraphics[width=1.8cm]{img/iac.png} \includegraphics[width=\linewidth]{img/h2020.jpg} \end{center} - \vspace{1cm} For this template, the \alert{IAC} is selected as + \vspace{1cm} For Maneage, the \alert{IAC} is selected as a \alert{Top European organization} funded to adopt RDA Recommendations and Outputs. @@ -1339,9 +1339,9 @@ - \begin{frame}{Workshop on this template at IAC: \alert{first week of April} (March 30th to April 3rd)} + \begin{frame}{Workshop on Maneage at IAC: \alert{first week of April} (March 30th to April 3rd)} - We are organizing a workshop to help interested \alert{early career researchers} adopt this template. + We are organizing a workshop to help interested \alert{early career researchers} adopt Maneage. \vspace{5mm} \begin{columns} @@ -1440,7 +1440,7 @@ In summary, they only \alert{store a built} environment (they are outputs, not g \begin{frame}{Summary:} - A fully working template/framework is introduced that will do the + Maneage is introduced as a customizable template that will do the following steps/instructions (all in simple plain text files). \begin{itemize} \item \alert{Automatically downloads} the necessary @@ -1463,16 +1463,16 @@ In summary, they only \alert{store a built} environment (they are outputs, not g output} data products. Ensuring the integrity/reproducibility of the result. \item \colorbox{green!30!white}{These slides are available at - \textcolor{blue}{\url{http://akhlaghi.org/pdf/reproducible-paper.pdf}}.} + \textcolor{blue}{\url{http://akhlaghi.org/pdf/maneage-introduction.pdf}}.} \end{itemize} \begin{tcolorbox}[width=\linewidth, boxsep=1pt, left=1pt, right=1pt, top=1pt, bottom=1pt] - For a technical description of the template's implementation, as - well as a checklist to customize it, and tips on good practices, + For a technical description of Maneage's implementation, as well + as a checklist to customize it, and tips on good practices, please see this page: - \textcolor{blue}{\footnotesize\url{https://gitlab.com/makhlaghi/reproducible-paper/blob/master/README-hacking.md}} + \textcolor{blue}{\footnotesize\url{https://gitlab.com/maneage/project/-/blob/maneage/README-hacking.md}} \end{tcolorbox} \end{frame} \end{document} diff --git a/tex/git-branch.tex b/tex/git-branch.tex index cf134a0..fa35e0d 100644 --- a/tex/git-branch.tex +++ b/tex/git-branch.tex @@ -1,17 +1,15 @@ -% Copyright (C) 2018-2019 Mohammad Akhlaghi <mohammad@akhlaghi.org> +%% Copyright (C) 2018-2020 Mohammad Akhlaghi <mohammad@akhlaghi.org> % -% This LaTeX source is free software: you can redistribute it and/or -% modify it under the terms of the GNU General Public License as -% published by the Free Software Foundation, either version 3 of the -% License, or (at your option) any later version. +%% This file is part of Maneage. Maneage is free software: you can +%% redistribute it and/or modify it under the terms of the GNU General +%% Public License as published by the Free Software Foundation, either +%% version 3 of the License, or (at your option) any later version. % -% This LaTeX source is distributed in the hope that it will be useful, -% but WITHOUT ANY WARRANTY; without even the implied warranty of -% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -% General Public License for more details. -% -% You should have received a copy of the GNU General Public License -% along with this LaTeX source. If not, see <https://www.gnu.org/licenses/>. +%% Maneage is distributed in the hope that it will be useful, but +%% WITHOUT ANY WARRANTY; without even the implied warranty of +%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +%% General Public License for more details: +%% <http://www.gnu.org/licenses/>. \begin{columns}[t] \column{5cm} @@ -60,7 +58,7 @@ %% circles. %% Template commits. - \draw[anchor=north] (0,0) node {\textbf{Template}}; + \draw[anchor=north] (0,0) node {\textbf{Maneage}}; \draw [fill=green!80!blue, opacity=0.5] (0,0.55cm) circle [radius=2.1mm]; \draw[anchor=east] (-5pt,0.55cm) node {\tiny\texttt{ad2c476}}; \draw [fill=green!80!blue, opacity=0.5] (0,1.55cm) circle [radius=2.1mm]; diff --git a/tex/project-graph.tex b/tex/project-graph.tex index 1ae9af4..5c76a19 100644 --- a/tex/project-graph.tex +++ b/tex/project-graph.tex @@ -1,17 +1,20 @@ -% Copyright (C) 2018-2019 Mohammad Akhlaghi <mohammad@akhlaghi.org> +%% Copyright (C) 2018-2020 Mohammad Akhlaghi <mohammad@akhlaghi.org> % -% This LaTeX source is free software: you can redistribute it and/or -% modify it under the terms of the GNU General Public License as -% published by the Free Software Foundation, either version 3 of the -% License, or (at your option) any later version. +%% This file is part of Maneage. Maneage is free software: you can +%% redistribute it and/or modify it under the terms of the GNU General +%% Public License as published by the Free Software Foundation, either +%% version 3 of the License, or (at your option) any later version. % -% This LaTeX source is distributed in the hope that it will be useful, -% but WITHOUT ANY WARRANTY; without even the implied warranty of -% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -% General Public License for more details. -% -% You should have received a copy of the GNU General Public License -% along with this LaTeX source. If not, see <https://www.gnu.org/licenses/>. +%% Maneage is distributed in the hope that it will be useful, but +%% WITHOUT ANY WARRANTY; without even the implied warranty of +%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +%% General Public License for more details: +%% <http://www.gnu.org/licenses/>. + + + + + \small \Wider[5em]{ \begin{center} |