1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
Reproduction pipeline for XXXXX.
For a general introduction to reproducible science as done here, please see
the link below:
http://akhlaghi.org/reproducible-science.html
Running the pipeline
====================
To reproduce the results, please take these steps in order:
1. Make sure you have the dependencies (below).
2. Configure/set your top-level directories with the command below. It is
recommended to modify the directories. Please read the comments (lines
starting with an `#') in the file that is opened by `./configure' and
set the directories accordingly.
$ ./configure
3. Run the following command to reproduce everything on 8 threads. If your
CPU has a different number of threads, change the number.
$ make -j8
Output
======
The output of the pipeline is a PDF file, describing the published paper.
Dependencies
============
To reproduce the results you need the following programs. Except for
Gnuastro, the version of the other programs will not make a difference.
Gnuastro Y.Y
------------
Gnuastro is a large collection of programs for astronomical data analysis
on the command-line. This is an intermediate version of Gnuastro (the
tarball is not officially released on the Gnuastro webpage). However,
this pipeline will ONLY work with this version of Gnuastro. For
convenience, this tarball is available in the following link:
https://zenodo.org/record/ZZZZZZ/files/gnuastro-Y.Y.tar.gz
To uncompress, build and install the Gnuastro tarball, follow the
instructions in the link below.
https://www.gnu.org/software/gnuastro/manual/html_node/Quick-start.html
If you successfully downloaded the tarball from the link above, please
ignore the rest of this section on Gnuastro. If not, this version of
Gnuastro is always present in Gnuastro's version controlled history and
this reproduction pipeline contains the fix to implement to it.
To build the above version of Gnuastro, please clone Gnuastro and
checkout this version as shown in the following commands:
$ git clone http://git.sv.gnu.org/r/gnuastro.git
$ git checkout Y.Y
Afterwords, you need to bootstrap Gnuastro as described in the following
link.
https://www.gnu.org/software/gnuastro/manual/html_node/Bootstrapping.html
You are now ready to configure, build and install Gnuastro as described
in the "Quick start" link above.
AWK
---
AWK is a program for working with text files. GNU AWK is the most common
implementation and it is commonly already installed on most systems.
Bash
----
Bash is the most common "shell" or command-line manager and available in
almost all systems (even if not the default). It doesn't need to be the
default for this pipeline to run.
flock
-----
This is a small program to manage file locks from the command-line. It is
available in all GNU/Linux distributions. For those operating systems
that don't have it, an implementation that is easy to install is
available in the link below.
https://github.com/discoteq/flock
Wget or cURL
------------
These programs (`wget' or `curl' on the command-line) are used to
download the input files if you don't already have them.
LaTeX
-----
LaTeX is used to build the final PDF of this pipeline. Some important
packages within LaTeX that this pipeline uses are: `biblatex' and
`pgfplots'.
|
