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
Add a CITATION file (fixes #309) #914
Conversation
That Zenodo doi thing looks cool too. Should we set that up as well? There is also the paper on transformation pipelines that Thomas and I wrote. It is probably the closest we get to a proper academic reference at the moment, although that isn't saying much... |
Also, shouldn't |
It is cited among other relevant ones (such as G. Evenden ones or @cffk ones) in http://proj4.org/references.html
Done |
Yes, I was just thinking if it made sense as a the paper to reference. Probably not.
Thanks |
I'm completely a stranger to academics habits and customs, so I won't take any strong position on this. It seems to me that the purpose was to credit the software and its numerous contributors in a short way. Of course there are a number of works and papers that have lead to it but we cannot quote all the centenial long publications on geodesy and cartography ;-) (or could we ? like https://physics.aps.org/featured-article-pdf/10.1103/PhysRevLett.116.061102 and its 6 page long autorship :-)) I guess someone writing a paper where PROJ is used could/should cite PROJ itself with the above citation, and if he uses a particular aspect of it, cite the appropriate paper that implements the details he use (so perhaps we could add a link in CITATION to http://proj4.org/references.html so they are aware of those publications related to PROJ) |
I'd consider R's CITATION the gold standard, as I see it used frequently in literature, which is impressive since it's a one letter software. Following their lead (and removing
|
I like the way R does it. Great example. I think OSGeo should be used as the organization so that it instead becomes:
The address seems to be related to the organization but it is not entirely clear to me if that is the case. If it is, there's a postal address for OSGeo here that could used. How is version numbers dealt with in this? There's a hell of a difference if you are using version 4.9.3 and some future version 7 for instance. Is the year static? Or is that to be updated with every major release? |
CITATION file updated with latest @kbevers 's content |
CITATION
Outdated
organization = {The Open Source Geospatial Foundation}, | ||
year = {2018}, | ||
url = {http://proj4.org/}, | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a nasty special character at the end of the file here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah was rather the lack of newline character. Fixed.
@cffk @busstoptaktik does this look reasonable to you? |
Yes, this is fine. I prefer "corporate authorship" to trying to keep a list of contributors up-to-date. One possible addition: say how a specific version of the library should be cited, with a "version" field and with a more specific URL? |
Good point. Referring to the citation in the text would with the above be "... something PROJ-related (PROJ Contributors, 2018) ...". It is a bit unusual, but I guess it works.
Here is an example of using the "software" BibTex category instead of the "manual" category as above. For PROJ this would be something like:
I think actually this is preferred since we still haven't got a stable manual that can be tied to each release (I hope we will have that with version 6, but let's see). |
If you start using Zenodo, you would get a DOI for each version (plus a generic "latest" version DOI too.) |
For these BiBTeX entries, Similar to what R does, only Another nitpick, remove the leading "The" from I'm not convinced a DOI will add any value that a URL already offers. |
Alright. My knowledge on this stuff is quite limited. The "software" option just seemed like the right thing to do, but if it isn't really used it is better to go with the "manual" option. So we update the year when new releases are issued and then it is up to whoever uses the reference to note exactly which version of the software was used? Maybe that should be explained in
That is a good point. To me, and likely many others, the lines are a bit blurred here. It should be checked wether it is okay or not to brand PROJ with the OSGeo name in this situation. What is the correct forum to ask that sort of thing? The discuss list? The OSGeo board list? This might also be a good occasion for the first small steps towards becoming a proper OSGeo project instead of the confusing setup we have today with MetaCRS. |
Can we merge this as it ? This can be later tuned... |
Sure. Do you mind removing the "the"s as suggested by @mwtoews ? And also update |
No description provided.