aboutsummaryrefslogtreecommitdiff
path: root/README-pipeline.md
AgeCommit message (Collapse)AuthorLines
2018-11-25Instructions on changing input dataset in pipelineMohammad Akhlaghi-5/+11
A step has been added to the checklist to correct the template's input dataset into the custom dataset necessary for each research.
2018-11-25Pipeline now downloads and uses an input datasetMohammad Akhlaghi-37/+18
In most analysis situations (except for simulations), an input dataset is necessary, but that part of the pipeline was just left out and a general `SURVEY' variable was set and never used. So with this commit, we actually use a sample FITS file from the FITS standard webpage, show it (as well as its histogram) and do some basic calculations on it. This preparation of the input datasets is done in a generic way to enable easy addition of more datasets if necessary.
2018-11-22Minor correction to README-pipeline.mdMohammad Akhlaghi-1/+0
There was an extra line (probably created by Emacs in a wrong command!) in the end of `README-pipeline.md' that has been removed.
2018-11-22Spell check in two READMEsMohammad Akhlaghi-5/+6
A spellcheck was run on the two README files.
2018-11-22Placeholder in README.md for pipeline dependenciesMohammad Akhlaghi-7/+7
A placeholder link is now used in `README.md' to encourage the pipeline designers to keep a backup of all the dependencies they use.
2018-11-22Top level READMEs renamed to be similar to actual projectMohammad Akhlaghi-0/+961
Until now, were were advising the users to rename the two README files after cloning the project. This was because online Git browsers usually display the `README.md' file, so we wanted the description of the pipeline to be visible in the pipeline, and later when a project adopts it, they can have their own `README.md'. But the problem is that any change in `REAME.md' will later cause conflicts with a project's `README.md'. So we are now using the same naming convention as the papers that use the pipeline.