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

Experience with Debian Science's Citations project? #45

Open
katrinleinweber opened this issue Feb 17, 2018 · 18 comments
Open

Experience with Debian Science's Citations project? #45

katrinleinweber opened this issue Feb 17, 2018 · 18 comments

Comments

@katrinleinweber
Copy link
Contributor

Hi!

I learned about https://wiki.debian.org/DebianScience/Citations recently and was wondering whether anyone here knows about that initiative? The "med" & "science" blends were apparently discussing and implementing (not sure how far) a system-wide way for users to gather citation info from packages they were using.

@mr-c
Copy link

mr-c commented Feb 18, 2018

Hello @katrinleinweber , I'm a member of Debian Med. As you see, we try to include citation information for every academic produced bioinformatic, medicine, or hospital related piece of software we package. Other teams within Debian do the same.

@tillea can provide more up to date information on the status of the effort.

@katrinleinweber
Copy link
Contributor Author

katrinleinweber commented Feb 18, 2018

Cool, thanks for the update! I'm not so much asking for details for myself, though, but whether there was a connection between efforts within Debian and within SCIWG ;-) Since you were not in the contributor list here I thought it's better to ask.

@tillea
Copy link

tillea commented Feb 21, 2018

Hi,
currently the status of citation handling is the following:

  • nightly job reads citation data from packaging Git of scientific
    packaging projects
  • citation data are gathered in SQL database
  • from this database all citation data are drawn and put into
  • The citations are also displayed on so called tasks pages
    There is no further use that I'm aware of. Please note that due to the move of the packaging Git repositories these data might be not as stable as usual until things have settled.
    There is no connection between Debian and SCIWG (yet).
    Kind regards, Andreas.

@katrinleinweber
Copy link
Contributor Author

Thanks for explaining :-) I understand that a Debian Science user would need to:

  1. include that .bib in their own workflow and
  2. start citing the package names.

If that's it: Neat!

Aside from that, I noticed that you use @article{…} and @misc{…} and didn't find a mailing list discussion about using @software{…}. I heard that the latter item type is not yet fully supported in Bib(La)TeX, but doesn't break anything, because it gets treated as @misc{...}. Do you have experience with that? Have you considered encouraging the use of @software{...}?

@mr-c
Copy link

mr-c commented Feb 21, 2018

@katrinleinweber Our initial focus was on research software with traditional publications.

A quick search of the entire Debian code base shows only two instances of @software in the source packages as citation instructions: octave-interval: https://sources.debian.org/src/octave-interval/3.1.0-5/CITATION/ and octave-splines: https://sources.debian.org/src/octave-splines/1.3.2-3/CITATION/ The remaining hits are two @software non-self citations: https://codesearch.debian.net/search?q=%40software%5B%5B%3Aspace%3A%5D%5D*%7B&perpkg=1

Looks like the two CITATION files were hand transformed to Type: software debian/upstream/metadata files:
https://sources.debian.org/src/octave-interval/3.1.0-5/debian/upstream/metadata/
https://sources.debian.org/src/octave-splines/1.3.2-3/debian/upstream/metadata/

However I can't find any octave in http://blends.debian.net/packages-metadata/debian.bib, so perhaps there is an issue on our side. @tillea Any ideas here?

While we could autogenerate @software citations for packages lacking them, Debian's notion of authorship is currently limited to names that appear after Copyright. From what I've seen, that is often very incomplete.

Once codemeta &/or the citation file format catches on we could obviously auto-ingest those.

@sdruskat
Copy link
Contributor

@mr-c Interesting. What would you need for the Citation File Format (and CodeMeta) to be auto-ingestable during your workflow?

@mr-c
Copy link

mr-c commented Feb 21, 2018

@sdruskat a script (citation_to_debian_metadata ?) that would discover the Citation File Format or CodeMeta file (starting from the current working directory) and transform it into our debian/upstream/metadata format, writing it there. Then the package maintainer would confirm the data and add it to the source package.

Is there any notion of presenting CodeMeta and/or CFF files in a standard location when applications are installed? In CWL we standardized how to discover them on the filesystem: http://www.commonwl.org/v1.0/CommandLineTool.html#Discovering_CWL_documents_on_a_local_filesystem

To discover CWL documents look in the following locations:

/usr/share/commonwl/

/usr/local/share/commonwl/

$XDG_DATA_HOME/commonwl/ (usually $HOME/.local/share/commonwl)

$XDG_DATA_HOME is from the XDG Base Directory Specification.

A similar approach would be useful for CodeMeta and/or CFF (/usr/share/metadata/, /usr/local/share/metadata/, etc.? )

Debian could then take advantage of such a standardized location in several ways: for example we'd also install the citation/metadata files to the appropriate directory even if the tool author forgot to instruct their build system to do so.

@rdicosmo
Copy link

rdicosmo commented Feb 21, 2018 via email

@sdruskat
Copy link
Contributor

@mr-c AFAIK, at the moment, there is no standard for placing CFF/CM files on a local file system. CFF suggests placing the file in the remote repo's root dir, and so does CodeMeta (right?).

I'll have to think about the standard location concept for CFF. What you describe for Debian packages seems useful, although may not be portable for other types of software.

As for a conversion script, I'll add https://wiki.debian.org/UpstreamMetadata to the list of formats that I'd like CFF (infrastructure) to support :).

@katrinleinweber
Copy link
Contributor Author

Hello @rdicosmo,

yes, of course entry type @article is quite appropriate. I meant the @misc ones only. Apologies for not writing that down.

Regarding: @software{...}. It doesn't seem like there is any risk of breaking things if people started to use it. Pushing the egg to hatch the chicken, so to speak ;-)

@katrinleinweber
Copy link
Contributor Author

[…] discover the Citation File Format or CodeMeta file […] and transform it into our debian/upstream/metadata format

Interesting! I understood it the other way round: CFF & CM being generated out of the community's existing metadata files/formats.

[…] install the citation/metadata files to the appropriate directory even if the tool author forgot to instruct their build system to do so.

That would be very convenient for developers! It seems to me that a) pushing the option to generate these files to the developers' local machines will find lower traction than b) to centralise that task. Which OTOH, should be accompanied by offering a suppress_{CFF|codemeta) flag somewhere .

@katrinleinweber
Copy link
Contributor Author

[…] location concept for CFF. What you describe for Debian packages seems useful, although may not be portable for other types of software.

Can at least the XDG_DATA_HOME standard be applied Linux-wide?

@mr-c
Copy link

mr-c commented Feb 21, 2018

I'll have to think about the standard location concept for CFF. What you describe for Debian packages seems useful, although may not be portable for other types of software.

CWL's choice of locations for discovery is not Debian specific. It was done by consulting the Filesystem Hierarchy Standard v3.0 and the XDG Base Directory Specification v0.6 neither of which is specific to a flavor/type of Linux/Unix.

@sdruskat
Copy link
Contributor

@mr-c Thanks, by "not portable" I meant other OSs, types of software that aren't installable; these however wouldn't be touched by that particular standard anyway, so makes sense.

@mr-c
Copy link

mr-c commented Feb 21, 2018

Interesting! I understood it the other way round: CFF & CM being generated out of the community's existing metadata files/formats.
I suggest 1) consuming all available metadata sources to produce a standardized format 2) puting that standardized format in as many useful places as possible 3) over time replace non-standardized formats with the standardized format

For example, eventually we may not need debian/upstream/metadata

@sdruskat
Copy link
Contributor

CFF & CM being generated out of the community's existing metadata files/formats.

For example, eventually we may not need debian/upstream/metadata

CFF at least, I've thought of as a source format rather than a target format (apart maybe for conversions from codemeta.json). Ideally either CFF/CM or both or something else can replace every other software metadata format, yes :).

@tillea
Copy link

tillea commented Feb 21, 2018 via email

@mr-c
Copy link

mr-c commented Feb 21, 2018

@tillea D'oh, that's right, sorry for the bother. I was curious how the type: software entries get rendered into BibTex

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

No branches or pull requests

5 participants