Age | Commit message (Collapse) | Author | Lines |
|
Until now, there was no technical introduction (on what is the
necessity of Maneage in relation to Jupyter, Conda and Docker)!
While preparing the slides for the ESO "Reproducibility and Open
Science in Astronomy" meeting, I thought it will be helpful to add
such a comparison.
|
|
|
|
|
|
Given that I have now moved to CEFCA, it was necessary to add the
logos of CEFCA and Aragon government (that is funding my contract).
|
|
The place of the lecture was updated and the figure on Git branching
from the Maneage paper is also brought-in to show the capabilities.
|
|
Until now, we would immeditely jump from the part on answering the
project's questions to Git branches. But this isn't too useful for
someone who doesn't know Git! So to start the Git branching
discussion, now we first show a small image of the workflow with a
"today" printed over it. Then another one with a "tomorrow". In the
next slide we abstract them to circles with hashes!
|
|
The short version of the slides is now ready. There is a '\longformat'
macro that will significantly increase the number of slides, but not
substantially (they are just the incremental things).
Some minor modifications were also made in the long version.
|
|
A first draft of the summarized slides was written for the talk in the
RDA Adoption week.
|
|
|
|
|
|
A few slides were added in the end to show the usage of the template
by various teams.
|
|
This helps connect better with the discussion on Git right after this
step.
|
|
Until now, there wasn't any good transition onto the project, so the
principles have now been added.
|
|
This helps viewers feel a better connection with a standard paper.
|
|
Until now, we were only showing three lower level Makefiles and
configuration files, but since we don't have much Bash and Python
files, I just made it four and shrank the extra space.
|
|
Until now, I was using the arXiv version, but now that the full PDF
with the special journal format is out, I thought its better to use
that.
|
|
Until now the directories were light green (similar to the Make files
in the data lineage plot) which was confusing. Now that they have a
different color, they can be better distinguished as directories
vs. files.
|
|
The file architecture plot was a little crowded, so I am now first
showing the files discussed in previous plots, and then showing the
whole thing. Also, the 4 commands necessary to reproduce a project are
added.
|
|
The image that is used for replicability was intentionally chosen
because it has an astronomer sitting behind the secondary mirror
(showing the hard work that goes into data collection). But the image
has too many details and the person can be completely missed by the
viewers. So I just darkened the outer parts and added an arrow to let
the audience understand the point of the image.
|
|
A verification step was recently added to the pipeline, so it was
necessary to add it here is well.
|
|
The set of slides that show how the built files relate to each other
through Makefiles was edited to first show the final target, and track
it all the way to the raw configuration files. This is in-line with
how I describe Make (that Make starts from the end).
This great suggestion was made by Idafen Santana PĂ©rez.
|
|
As Raul pointed out, to avoid confusion for a color-blind audience, or
when its printed in black-and-white, its best to not just base the
source-build distinction in the graph based on color.
With this commit, the source files have sharp edges and the built
files have round edges.
|
|
Some minor modifications were made in the graph showing the
organization of the analysis with Make. Also, a `tex/preamble.tex' was
defined to simplify the main source.
|
|
Until now, there was only one slide, with many boxes and arrows
connecting them. It was too complicated to understand for the viewers.
With this commit, it is broken up into separate slides, with each
box/arrow added on each slide as we progress. This helps clearly show
the logic behind all the connections.
The LaTeX source of this graph is in the paper that describes the
project, I will later bring that source into the slides too (and
remove all the extra figures).
|
|
Some arrows and text were added over the shown Makefile to better help
the eye when the viewers aren't familiar with Make.
|
|
Given that this project is now recieving funding from RDA EU 4.0, it
was necessary to add an EU flag/description for it. With the new EU
flag, it was necessary to re-arrange the logos to be more visually
appealing.
|
|
It helps the eyes find the Git checksum while also connecting it
visually with the previous slide showing the pictured happy
researcher.
|
|
Several figures were added to highlight the major points and add
better examples.
|
|
The information on the presentation place was updated for the RDA AMA
webinar and all the necessary logos that should have been added before
were now added. Also a diagram showing the relation between the source
and build files has been added after the introduction to Makefiles.
|
|
I had mistakenly forgot to include the four displayed M51 images into
the Git repository of these slides. They were being read from a
different directory on my system!
They are now in the `img/' directory and all references to them in the
LaTeX source of the slides has also been corrected.
This issue was raised by Charles Twardy.
Closes #4
|
|
The fact that we only displayed the Git checksum before showing it in
the paper could be a little confusing to people not much familiar with
Git. So a commit checksum (taken randomly from the history of these
slides) was added to it.
Also, some minor changes were done here and there.
|
|
The slides were updated (most importantly removing references from the
IAU meeting) for a talk in Collibra.
|
|
A few slides have been added to clarify the definition of
reproducibility and also to show how a paper using Gnuastro needs far
fewer dependencies.
|
|
After the previous experience of presenting the slides in Ghent, they
are reordered to be more clear and cause less confusion. In
particular, until this commit, I was describing the software build
steps in the end, so the audience mainly forgot about the analysis
steps and thought this template is just something like Docker or a
virtual machine.
With this commit, the steps are described in the same step that occur:
first how the software are built, then how the input data are
downloaded and finally how the software are run on the data and the
values are written into the paper.
|
|
For the introduction I am now using quotes from published papers.
|
|
A graph was added showing how Git branching and history are used to
verfiy the integrity of the result.
|
|
The slides were significantly upgraded to help in making a better
introduction and clearly demonstrating things for the users.
|
|
It was a long time since the last work on these slides. So the recent
changes (and in particular the installation of software) are now
described and my affiliation is also corrected).
|
|
The first version of these slides was presented in a talk I gave at
CRAL on the 9th of February (placed at the end of slides on the
science topic I was talking about). Later, I separated them into an
independent set of slides to help facilitate the discussions I was
having and also to upload on my webpage.
As the concept is evolving, I found my self having to make changes to
the slides, so to keep track of the slides and history of the changes,
I thought of making this repository.
|