boostorg / geometry

Boost.Geometry - Generic Geometry Library | Requires C++14 since Boost 1.75
http://boost.org/libs/geometry
Boost Software License 1.0
457 stars 216 forks source link

Missing Citation Guideline #714

Open fsimonis opened 4 years ago

fsimonis commented 4 years ago

Question How do I cite boost.geometry as a project?

Potential Solution Include a bibtex reference item in your readme, wiki, or as a separate file.

Background I would like to cite your project in an upcoming paper but cannot find a guideline on what to cite. Boost.geometry has already been cited a couple of times, but these citations are inconsistent.

It would be useful if you could add a citation guideline to give researchers a short guideline on how to correctly and consistently cite your project.

A consistently cited item also improves visibility in the academic field and citation numbers is a useful additional metric aside of GitHub stars and clones.

vissarion commented 3 years ago

@fsimonis sorry for overlooking here. Indeed there is no consistent way for citing boost.geometry.

The simplest way I see is using github-zenodo interaction and create a DOI, see https://guides.github.com/activities/citable-code

@barendgehrels @awulkiew @mloskot what do you think, any interest on getting a boost.geometry DOI?

mloskot commented 3 years ago

I don't have any uses of the DOI myself, but I can see it useful to others especially those who use and refer to Boost.Geometry in academic projects and papers. So, 👍 from me.