taskReproducible paper template - Tasks: task #15617, Individual program names and...

 
 

You are not allowed to post comments on this tracker with your current authentication level.

task #15617: Individual program names and versions as LaTeX macros

Submitted by:  Mohammad Akhlaghi <makhlaghi>
Submitted on:  Mon 27 Apr 2020 01:15:04 AM UTC  
 
Should Start On:  Sun 26 Apr 2020 11:00:00 PM UTC Should be Finished on:  Sun 26 Apr 2020 11:00:00 PM UTC
Category:  Analysis Priority:  5 - Normal
Status:  Postponed Privacy:  Public
Percent Complete:  0% Assigned to:  None
Open/Closed:  Open Effort:  0.00

Mon 27 Apr 2020 01:29:54 AM UTC, comment #2: 

Just a small correction: in the old days, I didn't "want" to do this, I actually did it! In fact it was also in `initialize.mk' and as the added software increased, it actually started slowing down `./project make' (because I would actually read the version numbers from the `--version' output!!!).

For example see initialize.mk from Commit d4138e68.

Mohammad Akhlaghi <makhlaghi>
Project Administrator
Mon 27 Apr 2020 01:24:33 AM UTC, comment #1: 

Thanks for bringing this up Boud, when I ran the default Maneage TARGET.conf settings with this option, I got this in my `initialize.mk':

\newcommand{\projectversion}{1378b41}
\newcommand{\gnuastroname}{{\sc GNU}}
\newcommand{\gnuastroversion}{Astronomy}

I guess its not yet suited for multi-word program names.

But generally doing this in the analysis phase (which is run every time the project authors are working on their analysis, but never changed unless they re-configure) is a waste of resources. It is also not easy as the example above shows.

In the old days, I also wanted to do this, but recognized that given the long paragraph we provide for all the software and their citations, such fine-grained macros for each software are redundant. Just for reference, that paragraph comes from `.build/tex/macros/dependencies.tex' and can be loaded into the paper anywhere that the project author wants ;-).

When someone wants to discuss the version of a software in other parts of the paper, they can just ask the reader to go and look in the acknowledgements.

What do you think?

In the end, if we do decide to have fine-grained LaTeX macros for each software name and version, its much more easier to do it at the end of the configuration script (where we built `dependencies.tex') ;-).

Mohammad Akhlaghi <makhlaghi>
Project Administrator
Mon 27 Apr 2020 01:15:04 AM UTC, original submission:  

This is based on a merge-request on GitLab (posted by Boud Roukema):

Until now, the user had to add extra rules to create macros for
the "target" programs listed in `TARGETS.conf` if s/he
wished to refer to them in the many body of the paper.

With this commit, LaTeX macros for a target program `foo` are
added for `\fooname` (in \sc font style) and `\fooversion` to
the temporary file `initialize.tex`.

This works correctly on a side branch. It has not been tested on
the main `maneage` branch because of the `basic.mk` bug:
https://savannah.nongnu.org/bugs/?58248

Mohammad Akhlaghi <makhlaghi>
Project Administrator

 

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by makhlaghi (Submitted the item)
  • -email is unavailable- added by makhlaghi
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

     

     

    Follows 1 latest change.

    Date Changed by Updated Field Previous Value => Replaced by
    2020-04-27 makhlaghi Carbon-Copy- => Added boud@cosmo.torun.pl

    Back to the top


    Powered by Savane 3.5