aboutsummaryrefslogtreecommitdiff
path: root/paper.tex
AgeCommit message (Collapse)AuthorLines
2020-04-13Imported Pedram's corrections, no conflictsMohammad Akhlaghi-8/+8
There weren't any conflicts in this merge.
2020-04-13Added short line to inform that there are tutorialsRaul Infante-Sainz-0/+1
With this commit, a short line telling that Maneage has tutorials showing the workflow in a practical way has been added. Because of we are near to the limit of words, I have added just a very short line. The sentence does not specify any file name since the tutorial(s) is not included (it will be in a near future).
2020-04-13Adding Julia to acknowledgments for creating the logoRaul Infante-Sainz-0/+1
With this commit, I have included a small line to recognize Julia Aguilar-Cabello as the designer of the Maneage's logo.
2020-04-13Fix typosPedram Ashofteh Ardakani-8/+8
2020-04-13Full existing contents summaried, only discussion to goMohammad Akhlaghi-32/+449
The contents until two commits ago when I started to summarize the paper are now in a new and shorter format: previously the discussion started on page 25, but now it starts on page 17. It is still a little longer than 8000 words, but not as significantly as before. I will add the discussion and also try to summarize it futher before submission.
2020-04-12First draft of first three sections of shortened paper are doneMohammad Akhlaghi-0/+418
As described in the previous commit, we had to shorten the paper to roughly 8000 words (which is significant decrease!). With this commit, I am committing the current version of the summarized paper, where the introduction, defintions and principles have now been summarized. I am now summarizing the rest (describing Maneage and the discussion).
2020-04-10Renamed initial paper to paper-long.tex, to write shorter new versionMohammad Akhlaghi-2588/+0
We just recently recognied that the final paper should not be longer than 8000 words. The easiest way was just to start a new `paper.tex' and bring in parts from the original/long version. We can use all the hard work that went into writing the long paper later (possibly in a manual for Maneage). So I don't want to suddenly distroy its history at this point. To let Git know about renaming the original `paper.tex' to `tex/src/paper-long.tex', I am making this commit. This commit doesn't have any `paper.tex' and only records the fact that it has been renamed. In the next commit, I'll re-create `paper.tex' which will host the short/final version. But thanks to this commit, if we later make any changes to long version, Git will know that it was originally the main `paper.tex'.
2020-04-10Acknowledged the help of Pedram, Zahra and SurenaMohammad Akhlaghi-0/+1
Thank you very much guys :-).
2020-04-10Fix spelling errors, suggest alternative wordsPedram Ashofteh Ardakani-135/+135
I tried to get all the words I knew. Some may be correct in different conventions. It definitely needs a second or third review for spell checking. Suggested some additional formatting, including but not limited to using the LaTeX \textsuperscript{} command for stating dates. Also, some unfamiliar rare words that finished with `-able` or `-ability` may need to be changed. Finding better alternatives to better simplify and ease the `readabiliy` ;-) of the paper - I see it's hard not to use them actually. It has got me wondering what better alternatives are available? We'll find out.
2020-04-10Suggest minor changes in the abstractPedram Ashofteh Ardakani-8/+9
to shorten some sentences, fix some spelling/typos, and further simplify some parts. I can see that there are some spelling errors in the rest of the paper. They will be taken care of in the next commit.
2020-04-10Imported Raul's corrections to the paper, minor conflict fixedMohammad Akhlaghi-50/+55
There was only a small conflict in the abstract with Zahra's corrections and that has been fixed.
2020-04-10Minor corrections based on Zahra's suggestionsMohammad Akhlaghi-7/+9
A parenthesis was added to the abstract to hightlight the importance of data lineage for reproducibility. Also, the definitions that Zahra had given for reproducibility were added as comments above the part on defining reproducibility. We'll later decide how to blend them in, if possible.
2020-04-09Minor typos and spelling corrections in Definitions, some notes addedRaul Infante-Sainz-24/+25
With this commit, I have corrected several minor typos in Section 2 (Definitions). I have also put a couple of notes for modify or ignore some phrases.
2020-04-09Minor typos and spelling corrections in IntroductionRaul Infante-Sainz-17/+17
With this commit, minor typos have been corrected in the Introduction section. The majority of them are just small corrections, others are in order to not use contractions ("did not" instead of "didn't" and so on). Other modifications have been added with the aim of remove some small portion of the phrases to make it more focused.
2020-04-09Trying to make the Abstract shorter, keywords sorted alphabeticallyRaul Infante-Sainz-11/+9
With this commit, I have tried to make the Abstract a bit shorter. I think it was too long considering that there are plenty of space in the paper to describe some of the points that were noticed in the abstract. The main point is just to try to be atractive to the reader being focused to the main points. In any case I think there are room for improving it. The keywords have also been sorted alphabetically.
2020-04-09Adding Raul as co-author of the paperRaul Infante-Sainz-1/+2
With this commit, I have added my name as co-author of the paper. Since my affiliation is the same as Mohammad's affiliations, I did not have to add any additional line for that.
2020-04-08Reproducibility in the abstractzahra sharbaf-2/+7
Because one of the most important properties of Manaege is reproducibility. I think is it better to say something about it in the abstract, like the thing that you do in your speech. With this commit, I noted something about it in the abstract.
2020-04-02Rewrote abstract, better organization in publishing sectionMohammad Akhlaghi-26/+116
I hadn't updated the abstract since first writing it. With this commit, it has been updated to be more precise and generically interesting, focusing more on the principles and usability. I also greatly improved the section on publishing the workflow.
2020-04-01Completed first draft of group working in build directoryMohammad Akhlaghi-4/+21
This section (of sharing a build directory between multiple members of the project) is also a good features of Maneage.
2020-03-31First draft of the version control section and figure completeMohammad Akhlaghi-22/+38
The figure was greatly improved, becoming much more clear and descriptive of some of the main advantages of having version control in a complete project like Maneage.
2020-03-30Section on starting new projects, and publishing project addedMohammad Akhlaghi-14/+77
With the main structure of Maneage explained, I have started to explain how a new project is created, along with a schematic diagram that shows two scenarios of how Git can help with project management.
2020-03-28Cleaned up the introduction, definitions for provenance and lineageMohammad Akhlaghi-117/+184
Until now, the introduction had repeated several things and also had a relatively long list of things to add in its end. Also, it was highly focused to scientific papers. With this commit, I effectively re-wrote it, with the starting paragraphs becoming more industry-friendly, while also focusing on the scientific cases. Many of the repetative parts were removed and the listed items in the end were put into the text in a much better context. Also, now that the name of the system involves "lineage" (and a lot of focus is put on it in the start) the terms data provenance and lineage were defined in the definition section. Some other intersting points that I encountered during the research on definitions were added to the discussion and final lists, and the DOI of one reference paper was corrected.
2020-03-23Analysis and configuration file sections completeMohammad Akhlaghi-43/+148
With this commit a description of these two important parts have been added to the project, along with several figures showing various parts of the files that are discussed. I also done some other restructuring of the figures and files to make things fit better into the the description of the paper.
2020-03-08Menke+20 example: properly count number of papers with softwareMohammad Akhlaghi-0/+1
Until now, I was mistakenly multiplying the fraction of papers in that journal. This is corrected with this commit.
2020-03-08Edited description of example subMakefile for analysis-1Mohammad Akhlaghi-22/+34
In order to make the description more clear and readable, the rules in the demonstrated Makefile (and their links to the data lineage plot) were made more clear.
2020-03-02Described the first analysis phase with a demo subMakefileMohammad Akhlaghi-60/+240
Until now, there was no explanation on an actual analysis phase, therefore with this commit an example scenario with a readable Makefile is included. The Data lineage graph was also simplified to both be more readable, and also to correspond to this new explanation and subMakefile. Some random edits/typos were also corrected and some references added for discussion.
2020-02-16Two values from the input dataset are now written into the paperMohammad Akhlaghi-1/+2
This was done just to get going with describing the analysis process.
2020-02-15Edits in text, added Menke+2020 as a referenceMohammad Akhlaghi-56/+92
The text was slightly improved/edited and I also recently came up to the Menke et al. 2020 (DOI:10.1101/2020.01.15.908111) which also has some good datasets we can use as a demonstration here.
2020-02-07Edited parts of the textMohammad Akhlaghi-109/+153
While reading over the already written parts (and hopefully complete the paper), they were edited/corrected to be more clear.
2020-02-06Minor edits to various partsMohammad Akhlaghi-56/+82
Some edits were made after rereading of some parts.
2020-01-27Analysis phase description started with Final paper and verificationMohammad Akhlaghi-11/+108
With this commit, the general outline of the analysis phase is given, as well as a description of the LaTeX macros and their relation to the paper and thier verification. Also, the data-lineage figure was updated to have references.tex also and some resizing of the folders in file-architecture to be more clear.
2020-01-26General project structure and configuration describedMohammad Akhlaghi-277/+517
In the last few days I have been writing these two sections in the middle of other work. But I am making this commit because it has already become a lot! I am now going onto the description of `./project make'.
2020-01-20New rendering of the file architecture plotMohammad Akhlaghi-0/+1
Until now the file architecture plot at the directories ontop of the top-level files. This made it hard to visually identify the top-level files. They are not placed ontop of the sub-directories and some space is added to highlight the files in the top-level directory and those in the subdirectories. Two other changes were made: - The symbolic links created in the top source directory are also shown. - The coding of this figure was made much more elegant by defining a PGFPlots node class and just changing the things that are direrent between each directory.
2020-01-20Added figure showing project's file structureMohammad Akhlaghi-82/+86
It was a little hard to describe the file structure so instead of using a standard listing as most papers do, I thought of showing the file and directory structure as boxes within each other (modeled on the Gnome disk-utility). Some other polishing was done throughout the paper also.
2020-01-18Raw draft (until now as a separate repository) importedMohammad Akhlaghi-52/+1499
Until now, I was writing the paper without the template. But we will soon be adding a tutorial to the template, and I thought it will be good to have an example demonstration here too. So I just brought the hole project into the template structure, allowing us to add the template analysis later when its ready, and also allowing us to easily reproduce this paper ofcourse (without having to worry about the host's TeXLive installation.
2020-01-18First set of customizations doneMohammad Akhlaghi-131/+5
The unnecessary parts were removed and the project now runs.
2020-01-01Copyright statements updated to include 2020Mohammad Akhlaghi-1/+1
Now that its 2020, its necessary to include this year in the copyright statements.
2019-11-04Acknowledged support from the RDA EU 4.0 grantMohammad Akhlaghi-1/+4
Since we got the RDA Adoption grant, it was necessary to add it in the acknowledgements.
2019-08-22Paper's title and author information moved to main paper.texMohammad Akhlaghi-0/+16
Until now, the paper's title and author information were set it `tex/src/preamble-header.tex'. But they are actually shown in the final PDF paper and a much better place to keep them is the top-level `paper.tex'. With this commit, the setting of the title and author names has been moved to `paper.tex', just after importing all the preambles. However, the basic package importation and low-level settings are still set in `tex/src/preamble-header.tex', because they are relatively low-level. This task was suggested by Deepak (Indian Institute of Astrophysics).
2019-08-18Updated README-hacking.md's checklist for better usabilityMohammad Akhlaghi-4/+10
After the checklist was applied in the 5th Indo-French Astronomy School, we found some cases in the checklist that were extra (and thus had to be removed), or were needed (and thus were added). Also the non-necessary steps for a first commit were moved to a separate/new section in the checklist for the people to add after doing their first commit. Also, the software part of the paper was moved to an appendix.
2019-05-21Source directory links to build directory all managed in configureMohammad Akhlaghi-2/+2
Until now, the `tex/build' symbolic link was put in the clone/source tree when the build-directory's `tex' directory was being built. Thanks to Roberto Baena, we just found a bug because of this behavior: when a second group member is trying to build the pipeline, since the build directory's `tex' directory already exists, no `tex/build' will be put in their clone/source directory. As a result, the PDF building will crash. To fix this (and keep things organized), the two `tex/build' and `tex/tikz' links (to the build directory) are now built in the configure step while it is building all the top-level directories. They are no longer built within the Makefiles. Also, a comment was added on top of every directory built during the configuration phase to be clear. This fixes bug #56362.
2019-04-15New architecture to separate software-building and analysis stepsMohammad Akhlaghi-4/+4
Until now, the software building and analysis steps of the pipeline were intertwined. However, these steps (of how to build a software, and how to use it) are logically completely independent. Therefore with this commit, the pipeline now has a new architecture (particularly in the `reproduce' directory) to emphasize this distinction: The `reproduce' directory now has the two `software' and `analysis' subdirectories and the respective parts of the previous architecture have been broken up between these two based on their function. There is also no more `src' directory. The `config' directory for software and analysis is now mixed with the language-specific directories. Also, some of the software versions were also updated after some checks with their webpages. This new architecture will allow much more focused work on each part of the pipeline (to install the software and to run them for an analysis).
2019-04-14Replaced all occurances of pipeline in textMohammad Akhlaghi-50/+50
All occurances of "pipeline" have been chanaged to "project" or "template" withint the text (comments, READMEs, and comments) of the template. The main template branch is now also named `template'. This was all because `pipeline' is too generic and couldn't be distinguished from the base, and customized project.
2019-04-13Corrected copyright notices and info about adding copyright infoMohammad Akhlaghi-1/+1
Until now, the files where the people were meant to change didn't have a proper copyright notice (for example `Copyright (C) YOUR NAME.'). This was wrong because the license does not convey copyright ownership. So the name of the file's original author must always be included and when people modify it (and add their own copyright-able modifications). With this commit, the file's original author (and email) are added to the copyright notice and when more than one person modified a file, both names have their individual copyright notice. Based on this, the description for adding a copyright notice in `README-hacking.md' has also been modified.
2019-04-12Gnuastro's citation included in its build targetMohammad Akhlaghi-2/+2
With this commit, we are applying the new style of citing software within the build rule of Gnuastro.
2019-04-05Software acknowledgement section is automatically generatedMohammad Akhlaghi-119/+6
Until now, management of the software names and versions in the paper was done manually (a macro had to be defined in `initialize.mk', then used in `paper.tex', so they had to be manually set in two places). Managing this was not easy. To fix this, with this commit, each software building rule's target is a text file that contains its human-readable name and its version. In the end, the configure script sorts them by their name and writes them into a LaTeX input file that we can easily import as a file into the main paper.
2019-04-04Dependency version LaTeX macros written at the end of configureMohammad Akhlaghi-43/+113
Until now, these versions were written in each run. This was mainly inherited from the old days of the pipeline, where we didn't know the software on the host. But now that we have almost everything under control, we can just write these LaTeX macros at the end of the configure script and make `initialize.mk' simpler and also (very slightly!) speed-up/simplify the processing.
2019-04-04Numpy and Scipy build on Mac imported into the main branchMohammad Akhlaghi-28/+41
We were developing the build of Numpy and Scipy on Mac in a parallel thread and things seems to be working relatively nice now. There were only two problems: 1) GCC still has some random building issues on Mac. 2) ATLAS shared libraries can't be built on Mac (so we used OpenBLAS to build Numpy and Scipy on both Mac and GNU/Linux). But for now, none of these problems are critical. So, we can progress in one branch. There were only very minor conflicts in the merge.
2019-04-02Copyright notice added to remaining filesMohammad Akhlaghi-3/+3
After doing a systematic search for files without a copyright notice, a few more were found that didn't have a notice. So a notice was added for them. I used this Bash command to find the files: for f in $(find ./ -type f); do \ if [[ $f != *.git* ]]; then \ n=$(grep -i copyright $f | wc -l); \ echo "$n $f"; \ fi; \ done | awk '$1==0'
2019-03-29Added Copyright to all TeX and README filesMohammad Akhlaghi-0/+18
In order to be more clear, a copyright statement was added to all the LaTeX and README files.