From e3bdc607a7fca8ebd876e1fa6002e679ad32f2c4 Mon Sep 17 00:00:00 2001 From: Mohammad Akhlaghi Date: Thu, 4 Jun 2020 04:09:21 +0100 Subject: Verification activated, README added, Proper metadata in plot data All the steps following the to-be-added (in 'README-hacking.md') publication checklist prior to the final check from new clone have been added: - 'README.md' file has been set. - "Reproducible supplement" was added just above the keywords, pointing to Zenodo. - A link to the to-be-uploaded data underlying the plot was added in the caption of the tools-per-year plot. - A new meta-data configuration file was added to store basic project metadata to be used throughout the project. This will later be taken into Maneage. For examle the project title is now stored here and written into the paper's LaTeX source and output datasets automatically. - Verification was activated and plot's data and LaTeX macro files are now automatically verified. - A complete metadata was added for the data underlying the plot. - A generic function was added in 'initialize.mk' that will automatically write project info and copyright in all plain-text outputs. --- README.md | 38 +++++++++++++++++--------------------- 1 file changed, 17 insertions(+), 21 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7216f1f..91d5527 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ -Reproducible source for XXXXXXXXXXXXXXXXX -========================================= +Reproducible source for paper introducing Maneage (MANaging data linEAGE) +------------------------------------------------------------------------- Copyright (C) 2018-2020 Mohammad Akhlaghi \ See the end of the file for license conditions. -This is the reproducible project source for the paper titled "**XXX XXXXX -XXXXXX**", by XXXXX XXXXXX, YYYYYY YYYYY and ZZZZZZ ZZZZZ that is published -in XXXXX XXXXX. +This is the reproducible project source for the paper titled "**Towards +Long-term and Archivable Reproducibility**", by Mohammad Akhlaghi, Raúl +Infante-Sainz, Boudewijn F. Roukema, David Valls-Gabaud, Roberto +Baena-Gallé. To reproduce the results and final paper, the only dependency is a minimal Unix-based building environment including a C compiler (already available @@ -18,8 +19,8 @@ button to download a compressed tarball of the project). If you have received this source from arXiv, please see the respective section below. ```shell -$ git clone XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -$ cd XXXXXXXXXXXXXXXXXX +$ git clone https://gitlab.com/makhlaghi/maneage-paper +$ cd maneage-paper $ ./project configure $ ./project make ``` @@ -34,8 +35,7 @@ https://maneage.org. -Building the project --------------------- +### Building the project This project was designed to have as few dependencies as possible without requiring root/administrator permissions. @@ -52,14 +52,11 @@ requiring root/administrator permissions. a directory given at configuration time), they will be used. Otherwise, a downloader (`wget` or `curl`) will be necessary to download any necessary tarball. The necessary tarballs are also - collected in the archived project on Zenodo (link below) [[TO - AUTHORS: UPLOAD THE SOFTWARE TARBALLS WITH YOUR DATA AND PROJECT - SOURCE TO ZENODO OR OTHER SIMILAR SERVICES. THEN ADD THE DOI/LINK - HERE.DON'T FORGET THAT THE SOFTWARE ARE A CRITICAL PART OF YOUR - WORK.]]. Just unpack that tarball, and when `./project configure` - asks for the "software tarball directory", give the address of the - unpacked directory that has all the tarballs. - https://doi.org/10.5281/zenodo.3408481 + collected in the archived project on Zenodo (link below). Just + unpack that tarball, and when `./project configure` asks for the + "software tarball directory", give the address of the unpacked + directory that has all the tarballs. + https://doi.org/10.5281/zenodo.3872248 2. Configure the environment (top-level directories in particular) and build all the necessary software for use in the next step. It is @@ -86,8 +83,8 @@ requiring root/administrator permissions. -Source from arXiv ------------------ +### Source from arXiv + If the paper is also published on arXiv, it is highly likely that the authors also uploaded/published the full project there along with the LaTeX sources. If you have downloaded (or plan to download) this source from @@ -155,8 +152,7 @@ arXiv, some minor extra steps are necessary: -Copyright information ---------------------- +### Copyright information This file and `.file-metadata` (a binary file, used by Metastore to store file dates when doing Git checkouts) are part of the reproducible project -- cgit v1.2.1