aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2018-02-15 14:10:29 +0100
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2018-02-15 14:22:04 +0100
commitf9de1124b675b2cfd09e9ad75aeda45ecea7319a (patch)
treea83fe1129e9ac5a641f15c57bd1ce7a1d795ec66 /README.md
parente45ac9f074a62a0dab26e4de86e4c97458384d18 (diff)
Gnuastro's memory mapping is now a local variable
As described in the commens above `MINMAPSIZE' of `LOCAL.mk.in', the amount of memory to map to HDD/SSD or keep in RAM is a local issue and not relevant to the pipeline's results. So it is now defined in a `gnuastro-local.conf' file. To keep the Makefiles clean, this file is created by the `./configure' script. To do this cleanly, the `./configure' script was also almost fully re-written with better functionality now.
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 14 insertions, 8 deletions
diff --git a/README.md b/README.md
index 59ecf71..ce4e4d8 100644
--- a/README.md
+++ b/README.md
@@ -158,16 +158,22 @@ been explained here), please let us know to correct it.
dependency of the pipeline and without it, the pipeline will complain
and abort. The main reason for this is to demonstrate how critically
important it is to version your software. If you don't want to install
- Gnuastro please follow the instructions in the list below. If you do
- have Gnuastro (or have installed it to check this pipeline), then
- after an initial check, try un-commenting the `onlyversion` line and
- running the pipeline to see the respective error. Such features in a
- software makes it easy to design a robust pipeline like this. If you
- have tried it and don't need Gnuastro in your pipeline, also follow
- this list:
+ Gnuastro please follow the instructions in the list below. If you have
+ installed Gnuastro and tried the pipeline, but don't need Gnuastro in
+ your pipeline, also follow the list below. If you do want to use
+ Gnuastro in your pipeline, be sure to un-comment the `onlyversion`
+ option in `reproduce/config/gnuastro/gnuastro.conf' file and set it to
+ your version of Gnuastro. This will force you to keep the pipeline in
+ match with the version of Gnuastro you are using all the time and also
+ allow commits to be exactly reproducible also (for example if you
+ update to a new version of Gnuastro during your research project). If
+ you will be using Gnuastro, you can also remove the "marks" (comments)
+ put in the relevant files of the list below to make them more
+ readable.
- Delete the description about Gnuastro in `README`.
- - Delete everything about Gnuastro in `reproduce/src/make/initialize.mk`.
+ - Delete marked parts in `configure`.
+ - Delete marked parts in `reproduce/src/make/initialize.mk`.
- Delete `and Gnuastro \gnuastroversion` from `tex/preamble-style`.
- **`README`**: Go through this top-level instruction file and make it fit