diff options
| -rw-r--r-- | .file-metadata | bin | 4141 -> 4085 bytes | |||
| -rw-r--r-- | README-hacking.md | 25 | ||||
| -rw-r--r-- | README.md | 25 | ||||
| -rw-r--r-- | paper.tex | 18 | ||||
| -rw-r--r-- | tex/src/delete-me-demo.tex | 20 | ||||
| -rw-r--r-- | tex/src/delete-me.tex | 18 | ||||
| -rw-r--r-- | tex/src/preamble-biblatex.tex | 19 | ||||
| -rw-r--r-- | tex/src/preamble-header.tex | 18 | ||||
| -rw-r--r-- | tex/src/preamble-necessary.tex | 18 | ||||
| -rw-r--r-- | tex/src/preamble-pgfplots.tex | 31 | ||||
| -rw-r--r-- | tex/src/preamble-style.tex | 18 |
11 files changed, 202 insertions, 8 deletions
diff --git a/.file-metadata b/.file-metadata Binary files differindex 18e0cd8..7336b45 100644 --- a/.file-metadata +++ b/.file-metadata diff --git a/README-hacking.md b/README-hacking.md index e7a3f44..62ba01e 100644 --- a/README-hacking.md +++ b/README-hacking.md @@ -1,3 +1,6 @@ +Copyright (C) 2018-2019 Mohammad Akhlaghi. +See the end of the file for license conditions. + Reproducible paper template =========================== @@ -1011,3 +1014,25 @@ that is not reproducible (due to incomplete information by the author) is not scientific: the readers have to have faith in the subjective experience of the authors in the very important choice of configuration values and order of operations: this is contrary to the scientific spirit. + + + + + +Copyright information +--------------------- +This file is part of the reproducible paper template + https://gitlab.com/makhlaghi/reproducible-paper + +This template 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 template 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 Template. If not, see <https://www.gnu.org/licenses/>.
\ No newline at end of file @@ -1,3 +1,6 @@ +Copyright (C) 2018-2019 Mohammad Akhlaghi. +See the end of the file for license conditions. + Reproduction pipeline for paper XXXXXXX ======================================= @@ -78,3 +81,25 @@ This pipeline was designed to have as few dependencies as possible. ```shell $ .local/bin/make -j8 ``` + + + + + +Copyright information +--------------------- +This file is part of the reproducible paper template + https://gitlab.com/makhlaghi/reproducible-paper + +This template 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 template 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 Template. If not, see <https://www.gnu.org/licenses/>.
\ No newline at end of file @@ -1,3 +1,5 @@ +%% Copyright (C) 2018-2019 Mohammad Akhlaghi. +%% See the end of the file for license conditions. \documentclass[10pt, twocolumn]{article} %% This is a convenience variable if you are using PGFPlots to build plots @@ -238,3 +240,19 @@ research would not be possible without them. %% Finish LaTeX \end{document} + +%% This file is part of the reproducible paper template +%% https://gitlab.com/makhlaghi/reproducible-paper + +%% This template 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 template 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 Template. If not, see <https://www.gnu.org/licenses/>. diff --git a/tex/src/delete-me-demo.tex b/tex/src/delete-me-demo.tex index 8174bc8..2575e61 100644 --- a/tex/src/delete-me-demo.tex +++ b/tex/src/delete-me-demo.tex @@ -1,3 +1,23 @@ +%% Plot the demonstration image and its histogram. +% +%% Original author: +%% Mohammad Akhlaghi <mohammad@akhlaghi.org> +%% Contributing author(s): +%% Copyright (C) 2019, Mohammad Akhlaghi. +% +%% This template 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 template 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 template. If not, see <http://www.gnu.org/licenses/>. + \begin{tikzpicture} %% The displayed WFPC2 image. diff --git a/tex/src/delete-me.tex b/tex/src/delete-me.tex index fc1a1f9..1382b66 100644 --- a/tex/src/delete-me.tex +++ b/tex/src/delete-me.tex @@ -1,4 +1,22 @@ %% PGFPlots code to plot a random set of numbers as demo +%% +%% Original author: +%% Mohammad Akhlaghi <mohammad@akhlaghi.org> +%% Contributing author(s): +%% Copyright (C) 2019, Mohammad Akhlaghi. +% +%% This template 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 template 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 template. If not, see <http://www.gnu.org/licenses/>. \begin{tikzpicture} diff --git a/tex/src/preamble-biblatex.tex b/tex/src/preamble-biblatex.tex index bd99502..6358fb1 100644 --- a/tex/src/preamble-biblatex.tex +++ b/tex/src/preamble-biblatex.tex @@ -11,7 +11,24 @@ %% reference. The file suffix doesn't have to be `.bib'. This naming %% helps in clearly identifying the files and avoiding places that %% complain about `.bib' files. - +% +%% Original author: +%% Mohammad Akhlaghi <mohammad@akhlaghi.org> +%% Contributing author(s): +%% Copyright (C) 2018-2019, Mohammad Akhlaghi. +% +%% This template 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 template 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 template. If not, see <http://www.gnu.org/licenses/>. diff --git a/tex/src/preamble-header.tex b/tex/src/preamble-header.tex index eb83c27..b2ca364 100644 --- a/tex/src/preamble-header.tex +++ b/tex/src/preamble-header.tex @@ -1,5 +1,23 @@ %% The headers: title, authors, top of pages and section title formatting %% of the final LaTeX file are configured here. +% +%% Original author: +%% Mohammad Akhlaghi <mohammad@akhlaghi.org> +%% Contributing author(s): +%% Copyright (C) 2018-2019, Mohammad Akhlaghi. +% +%% This template 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 template 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 template. If not, see <http://www.gnu.org/licenses/>. diff --git a/tex/src/preamble-necessary.tex b/tex/src/preamble-necessary.tex index e6ac18e..cdb6137 100644 --- a/tex/src/preamble-necessary.tex +++ b/tex/src/preamble-necessary.tex @@ -3,6 +3,24 @@ %% These are a set of packages that have been commonly necessary in most %% LaTeX usages. However, if any are not needed in your work, please feel %% free to remove them. +% +%% Original author: +%% Mohammad Akhlaghi <mohammad@akhlaghi.org> +%% Contributing author(s): +%% Copyright (C) 2018-2019, Mohammad Akhlaghi. +% +%% This template 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 template 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 template. If not, see <http://www.gnu.org/licenses/>. diff --git a/tex/src/preamble-pgfplots.tex b/tex/src/preamble-pgfplots.tex index 4999656..cd68658 100644 --- a/tex/src/preamble-pgfplots.tex +++ b/tex/src/preamble-pgfplots.tex @@ -1,11 +1,11 @@ %% PGFPlots settings %% ----------------- -%% +% %% PGFPLOTS is a package in (La)TeX for making plots internally. It fits %% nicely with the purpose of a reproduction pipeline. But it isn't %% mandatory. Therefore if you don't need it, just comment/delete the line %% that includes this file in the top LaTeX source (`paper.tex'). -%% +% %% However, TiKZ and PGFPlots are the recommended way to include figures %% and plots in your paper. There are two main reasons: 1) it follows the %% same LaTeX settings as the text of the paper, so the figures will be in @@ -17,21 +17,21 @@ %% but it requires Python and Numpy. The latter is not easy to build from %% source, so after a few years, installing the required version can be %% very frustrating. -%% +% %% Keeping all BibLaTeX settings in a separate preamble was done in the %% spirit of modularity to 1) easily managable, 2) If a similar BibLaTeX %% configuration is necessary in another LaTeX compilation, this file can %% just be copied there and used. -%% +% %% PGFPlots uses the (La)TeX TiKZ package to build plots. So we will first %% do the settings that are necessary in TiKZ, and then go onto the actual %% PGFPlots package. %% %% USAGE: -%% +% %% - All plots are made within a `tikz' directory (that must already be %% present in the location LaTeX is run). -%% +% %% - Use `\includetikz{XXXX}' to make/use the figure. If a `makepdf' LaTeX %% macro is not defined, then \includetikz will assume a `XXXX.pdf' file %% exists in `tex/tikz' and simply import it. If `makepdf' is defined, @@ -39,7 +39,24 @@ %% on `tex/XXXX.tex'. Note that if the contents of `tex/src/XXXX.tex' %% hasn't changed since the last build. TiKZ/PGFPlots won't rebuild the %% plot. - +% +%% Original author: +%% Mohammad Akhlaghi <mohammad@akhlaghi.org> +%% Contributing author(s): +%% Copyright (C) 2018-2019, Mohammad Akhlaghi. +% +%% This template 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 template 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 template. If not, see <http://www.gnu.org/licenses/>. diff --git a/tex/src/preamble-style.tex b/tex/src/preamble-style.tex index fb08df7..54f3598 100644 --- a/tex/src/preamble-style.tex +++ b/tex/src/preamble-style.tex @@ -5,6 +5,24 @@ %% initial/internal phase or part of a larger effort, so it has a basic %% style defined here as a preamble. To ignore it, uncomment or delete the %% respective line in `paper.tex'. +%% +%% Original author: +%% Mohammad Akhlaghi <mohammad@akhlaghi.org> +%% Contributing author(s): +%% Copyright (C) 2019, Mohammad Akhlaghi. +% +%% This template 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 template 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 template. If not, see <http://www.gnu.org/licenses/>. |