Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update citation policy for theory used #2287

Open
scarlehoff opened this issue Feb 28, 2025 · 4 comments
Open

Update citation policy for theory used #2287

scarlehoff opened this issue Feb 28, 2025 · 4 comments
Assignees
Labels
documentation Issues and PRs related to documentation

Comments

@scarlehoff
Copy link
Member

The theories should include a bibtex file with the relevant citations so that if someone uses a theory you can check which software should you cite.

I'm adding this issue here because the citation policy is in the docs of nnpdf but perhaps we could have a pineko sanitize theory or something which will create the .tgz file and looking at the pineappl grids inside prepare the citations?

Or we just copy the entire citation list that we will have for 4.1 into the docs. I just realized that things like EKO should also be referred there.
We don't want to get sued!

@scarlehoff scarlehoff added the documentation Issues and PRs related to documentation label Feb 28, 2025
@felixhekhorn
Copy link
Contributor

first the obvious statements:

  • all FK tables (beyond 4.0) use EKO and should cite EKO according to the citation policy given at the repo
  • all FK tables (beyond 4.0) use PineAPPL and should cite PineAPPL according to the citation policy given at the repo

then only grids remain, for which I can see an easy option: the interfaces in pinefarm should provide a citation string, which pinefarm then adds to the grids (together with version numbers etc.) - so for me this should be a pinefarm issue.

(There is also a too complicated point of view: we could also let pinecards add dedicated citations, e.g. to specific codes in mg5 or similar - but this is too much I would say ... for DIS we are not citing all the literature that went into DIS; those references are just inside yadism)

@scarlehoff
Copy link
Member Author

scarlehoff commented Feb 28, 2025

For reference, I meant this citation policy here: https://docs.nnpdf.science/get-started/cite.html which is still that of 4.0. People looking at that won't look into pinefarm, pineko, etc so I think at least the general policy should be as easily visible as possible.

@felixhekhorn
Copy link
Contributor

but the list there is quasi the point I was worried about. If people ask us explicitly to be listed there, we can do that - but that we do manually case by case. I would not do this for everything, because it would be very hard to draw a line on what to cite and what not (beyond the program itself). Just to name a completely random example: should we always cite my thesis just because it contains some genuine new coefficient functions, which we use in all DIS calculation? or should we cite the paper on which my thesis is 100% (more or less) built? should we cite Numpy and friends (without we were completely lost)?

just to stress: I'm happy to cite whoever, but I wonder if we need an automatic tool for that

@scarlehoff
Copy link
Member Author

scarlehoff commented Feb 28, 2025

What I'm suggesting is that we should change that list to nnpdf / eko / pineappl and then perhaps a script that can automatically read the citations from the theory fktables.

The last sentence about 4.1 was meant to be snarky since I remembered what happened back in the day with eko :P. Indeed, if people start asking to be put there, we should put the whole 4.1 list of citations, numpy included.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues and PRs related to documentation
Projects
None yet
Development

No branches or pull requests

4 participants