Corrected bug in using local copy of input dataset

As described in Maneage's commit 2bd2e2f18 (which I found while testing
this project), the existing download recipe had problems when using a local
copy of the input dataset. It was first fixed here, then implemented there.

Also, to clarify things for a new user, some long comments were added at
the top of 'INPUTS.conf' to describe each of the variables, that comment
has also been put here (and is also in commit 2bd2e2f18 of Maneage).

1 files changed, 32 insertions, 2 deletions

diff --git a/reproduce/analysis/config/INPUTS.conf b/reproduce/analysis/config/INPUTS.conf
index b1cf546..ee52abb 100644
--- a/reproduce/analysis/config/INPUTS.conf
+++ b/reproduce/analysis/config/INPUTS.conf
@@ -1,6 +1,36 @@
-# Input files necessary for this project.
+# Input files necessary for this project, the variables defined in this
+# file are primarily used in 'reproduce/analysis/make/download.mk'. See
+# there for precise usage of the variables. But comments are also provided
+# here.
 #
-# This file is read by the configure script and running Makefiles.
+# 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.
+#
+#  1) Local file name ('WFPC2IMAGE' 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'
+#     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
+#     important for an automatic verification of the file. You can
+#     calculate it by running 'md5sum' on your desired file.
+#
+#  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.
+#
+#  4) The full dataset URL ('WFPC2URL' 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.
 #
 # Copyright (C) 2018-2020 Mohammad Akhlaghi <mohammad@akhlaghi.org>
 #