svalinn / DAGMC

Direct Accelerated Geometry Monte Carlo Toolkit
https://svalinn.github.io/DAGMC
Other
103 stars 65 forks source link

first draft of citation file #790

Closed shimwell closed 2 years ago

shimwell commented 2 years ago

Description

Following on from discussion with @kkiesling in the Slack channel here is a draft citation file.

I have been through the contributors section and added details for each github username that has contributed. This is difficult for a few user accounts that don't have first or last names in their profile. Perhaps these users can be tagged using @ if this PR goes ahead. ORCID are also difficult to find for everyone so perhaps the contributors with missing ORCID can also be tagged and asked for their ORCID.

Currently the list is sorted by commits as that was easy to get from the contributors page, but could be changed to any order that is preferred? Also a paper could be added if that is preferred?

Further details

Motivation and Context

Helps users easily cite the software using the standard GitHub CITATION file which produces a bibtex and other formats citation link on the right hand side of the repository. See here for more details https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

Changes

documentation update

Behavior

Citation of the software is perhaps less frequent and harder than it needs to be

kkiesling commented 2 years ago

This has prompted me to find my ORCID that I made a long time ago and haven't ever used.. https://orcid.org/0000-0002-1215-2541

pshriwise commented 2 years ago

@iulian787 and @vijaysm are almost certainly Iulian Grindeanu (https://orcid.org/0000-0002-0264-8236) and Vijay S. Mahadevan (https://orcid.org/0000-0002-3337-2607) from ANL.

It looks like @SudoVim is from pullrequest.com?

SudoVim commented 2 years ago

It looks like @SudoVim is from pullrequest.com?

Yeah, I'm from pullrequest.com. Do you still need my last name? At any rate, I updated my profile with my company and name.

shimwell commented 2 years ago

It looks like @SudoVim is from pullrequest.com?

Yeah, I'm from pullrequest.com. Do you still need my last name? At any rate, I updated my profile with my company and name.

Super, thanks. I shall add your names as it is on the profile

shimwell commented 2 years ago

I think we have nearly everyone who has contributed apart

Just missing the name for @dqwu