reproducibility

This commit is contained in:
Motiejus Jakštys 2021-05-19 22:57:50 +03:00 committed by Motiejus Jakštys
parent 180912b036
commit 3dded8a9df

View File

@ -796,7 +796,9 @@ already-working code.
\subsection{Reproducibility} \subsection{Reproducibility}
\label{sec:reproducing-the-paper} \label{sec:reproducing-the-paper}
% TODO: andriub: Turi būti aiškiai nurodytos instrukcijos, kaip atkartoti veiksmus. Tam gali įdėti trumpą tekstą, kad rezultatais pasidalinta github, projekto pasileidimui reikalavimai nurodyti programinio kodo readme apraše. % TODO done: andriub: Turi būti aiškiai nurodytos instrukcijos, kaip atkartoti
% veiksmus. Tam gali įdėti trumpą tekstą, kad rezultatais pasidalinta github,
% projekto pasileidimui reikalavimai nurodyti programinio kodo readme apraše.
It is widely believed that the ability to reproduce the results of a published It is widely believed that the ability to reproduce the results of a published
study is important to the scientific community. In practice, however, it is study is important to the scientific community. In practice, however, it is
@ -810,6 +812,9 @@ of it, all the illustrations in this paper are generated using that algorithm,
from a predefined list of test geometries (test geometries were explained in from a predefined list of test geometries (test geometries were explained in
section~\ref{sec:automated-tests}). section~\ref{sec:automated-tests}).
Besides embedded in this document, this article itself, and code for this
article are accessible on github as of 2021-05-21\cite{wmsql}.
Instructions how to re-generate all the visualizations are found in Instructions how to re-generate all the visualizations are found in
appendix~\ref{sec:code-regenerate}. The visualization code serves as a good appendix~\ref{sec:code-regenerate}. The visualization code serves as a good
example reference for anyone willing to start using the algorithm. example reference for anyone willing to start using the algorithm.
@ -1319,7 +1324,12 @@ This section contains code listings of a subset of files tightly related to the
Like explained in section~\ref{sec:reproducing-the-paper}, illustrations in Like explained in section~\ref{sec:reproducing-the-paper}, illustrations in
this paper are generated from a small list of sample geometries. To observe this paper are generated from a small list of sample geometries. To observe
the source geometries or regenerate this paper, run this script (assuming the source geometries or regenerate this paper, run this script (assuming
name of this document is {\tt mj-msc-full.pdf}): name of this document is \textsc{mj-msc-full.pdf}).
This script will extract the source files from the \textsc{mj-msc-full.pdf} to
a temporary directory, run the top-level \textsc{make} command, and display
the generated document. Source code for the algorithm, as well as other
supporting files, can be found in the temporary directory.
\inputcode{bash}{extract-and-generate} \inputcode{bash}{extract-and-generate}