Better names and comments in INPUTS.conf

Until now, the dataset's configuration names had a 'WFPC2' prefix. But this
very alien to anyone that is not familiar with the history of the Hubble
Space Telescope (the camera is no longer used! Its just used here since its
one of the standard FITS files from the FITS standard webpage).

With this commit the variable names have been modified to be more readable
and clear (having a 'DEMO-' prefix). Also the comments of 'INPUTS.conf'
(describing the purpose of each variable) were edited and made more clear.

3 files changed, 32 insertions, 28 deletions

diff --git a/reproduce/analysis/config/INPUTS.conf b/reproduce/analysis/config/INPUTS.conf
index 5e6c425..60abd49 100644
--- a/reproduce/analysis/config/INPUTS.conf
+++ b/reproduce/analysis/config/INPUTS.conf
@@ -5,30 +5,34 @@
 #
 # Necessary variables for each input dataset are listed below. Its good
 # that all the variables of each file have the same base-name (in the
-# example below 'WFPC2') with descriptive suffixes, also put a short
-# comment above each group of variables for each dataset, shortly
-# explaining what it is.
+# example below 'DEMO') with descriptive suffixes, also put a short comment
+# above each group of variables for each dataset, shortly explaining what
+# it is.
 #
-#  1) Local file name ('WFPC2IMAGE' below): this is the name of the dataset
+#  1) Local file name ('DEMO-DATA' below): this is the name of the dataset
 #     on the local system (in 'INDIR', given at configuration time). It is
 #     recommended that it be the same name as the online version of the
-#     file like the case here (note how this variable is used in 'WFPC2URL'
+#     file like the case here (note how this variable is used in 'DEMO-URL'
 #     for the dataset's full URL). However, this is not always possible, so
 #     the local and server filenames may be different. Ultimately, the file
 #     name is irrelevant, we check the integrity with the checksum.
 #
-#  2) The MD5 checksum of the file ('WFPC2MD5' below): this is very
+#  2) The MD5 checksum of the file ('DEMO-MD5' below): this is very
 #     important for an automatic verification of the file. You can
-#     calculate it by running 'md5sum' on your desired file.
+#     calculate it by running 'md5sum' on your desired file. You can also
+#     use any other checksum tool that you prefer, just be sure to correct
+#     the respective command in 'reproduce/analysis/make/download.mk'.
 #
-#  3) The human-readable size of the file ('WFPC2SIZE' below): this is an
-#     optional feature which you can use for in the script that is loaded
-#     at configure time ('reproduce/software/shell/configure.sh'). When
-#     asking for the input-data directory, you can print some basic
-#     information of the files for users to get a better feeling of the
-#     volume. See that script for an example using this demo dataset.
+#  3) The human-readable size of the file ('DEMO-SIZE' below): this is an
+#     optional variable, mainly to help a reader of your project get a
+#     sense of the volume they need to download if they don't already have
+#     the dataset. So it is highly recommended to add it (future readers of
+#     your project's source will appreciate it!). You can get it from the
+#     output of 'ls -lh' command on the file. Optionally you can use it in
+#     messages during the configuration phase (when Maneage asks for the
+#     input data directory), along with other info about the file(s).
 #
-#  4) The full dataset URL ('WFPC2URL' below): this is the full URL
+#  4) The full dataset URL ('DEMO-URL' below): this is the full URL
 #     (including the file-name) that can be used to download the dataset
 #     when necessary. Also, see the description above on local filename.
 #
@@ -43,9 +47,8 @@
 
 
 
-# Demonstration image used in the histogram plot (remove this when
-# customizing).
-WFPC2IMAGE = WFPC2ASSNu5780205bx.fits
-WFPC2MD5   = a4791e42cd1045892f9c41f11b50bad8
-WFPC2SIZE  = 62kb
-WFPC2URL   = https://fits.gsfc.nasa.gov/samples/$(WFPC2IMAGE)
+# Demo dataset used in the histogram plot (remove when customizing).
+DEMO-DATA = WFPC2ASSNu5780205bx.fits
+DEMO-MD5  = a4791e42cd1045892f9c41f11b50bad8
+DEMO-SIZE = 62K
+DEMO-URL  = https://fits.gsfc.nasa.gov/samples/$(DEMO-DATA)
diff --git a/reproduce/analysis/make/delete-me.mk b/reproduce/analysis/make/delete-me.mk
index f45f9ea..bc94bf1 100644
--- a/reproduce/analysis/make/delete-me.mk
+++ b/reproduce/analysis/make/delete-me.mk
@@ -61,8 +61,8 @@ $(dm-squared): $(pconfdir)/delete-me-squared-num.conf | $(tex-publish-dir)
 
 
 
-# WFPC2 image PDF
-# -----------------
+# Demo image PDF
+# --------------
 #
 # For an example image, we'll make a PDF copy of the WFPC II image to
 # display in the paper.
@@ -82,8 +82,8 @@ $(dm-img-pdf): $(dm-histdir)/%.pdf: $(indir)/%.fits | $(dm-histdir)
 
 
 
-# Histogram of WFPC2 image
-# ------------------------
+# Histogram of demo image
+# -----------------------
 #
 # For an example plot, we'll show the pixel value histogram also. IMPORTANT
 # NOTE: because this histogram contains data that is included in a plot, we
@@ -103,7 +103,7 @@ $(dm-img-histogram): $(tex-publish-dir)/%-histogram.txt: $(indir)/%.fits \
         # metadata from '$@.data', and add copyright.
 	echo "# Histogram of example image to demonstrate Maneage (MANaging data linEAGE)." \
 	     > $@.tmp
-	echo "# Example image URL: $(WFPC2URL)/$(WFPC2IMAGE)" >> $@.tmp
+	echo "# Example image URL: $(DEMO-URL)" >> $@.tmp
 	echo "# " >> $@.tmp
 	awk '/^# Column .:/' $@.data >> $@.tmp
 	echo "# " >> $@.tmp
@@ -162,7 +162,7 @@ $(mtexdir)/delete-me.tex: $(dm-squared) $(dm-img-pdf) $(dm-img-histogram) \
 	v=$$(echo "$$mm" | awk '{printf "%.3f", $$2}');
 	echo "\newcommand{\deletememax}{$$v}"             >> $@
 
-        # Write the statistics of the WFPC2 image as a macro.
+        # Write the statistics of the demo image as a macro.
 	mean=$$(awk     '{printf("%.2f", $$1)}' $(dm-img-stats))
 	echo "\newcommand{\deletemewfpctwomean}{$$mean}"          >> $@
 	median=$$(awk   '{printf("%.2f", $$2)}' $(dm-img-stats))
diff --git a/reproduce/analysis/make/download.mk b/reproduce/analysis/make/download.mk
index bc8b8ce..fb3f523 100644
--- a/reproduce/analysis/make/download.mk
+++ b/reproduce/analysis/make/download.mk
@@ -58,7 +58,7 @@ $(inputdatasets): $(indir)/%.fits: | $(indir) $(lockdir)
 
         # Set the necessary parameters for this input file.
 	if   [ $* = wfpc2 ]; then
-	  localname=$(WFPC2IMAGE); url=$(WFPC2URL); mdf=$(WFPC2MD5);
+	  localname=$(DEMO-DATA); url=$(DEMO-URL); mdf=$(DEMO-MD5);
 	else
 	echo; echo; echo "Not recognized input dataset: '$*.fits'."
 	echo; echo; exit 1
@@ -84,6 +84,7 @@ $(inputdatasets): $(indir)/%.fits: | $(indir) $(lockdir)
 	sum=$$(md5sum $$unchecked | awk '{print $$1}')
 	if [ $$sum = $$mdf ]; then
 	  mv $$unchecked $@
+	  echo "Integrity confirmed, using $@ in this project."
 	else
 	  echo; echo;
 	  echo "Wrong MD5 checksum for input file '$$localname':"
@@ -102,4 +103,4 @@ $(inputdatasets): $(indir)/%.fits: | $(indir) $(lockdir)
 # It is very important to mention the address where the data were
 # downloaded in the final report.
 $(mtexdir)/download.tex: $(pconfdir)/INPUTS.conf | $(mtexdir)
-	echo "\\newcommand{\\wfpctwourl}{$(WFPC2URL)}" > $@
+	echo "\\newcommand{\\wfpctwourl}{$(DEMO-URL)}" > $@