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

Is there any citation for use in scientific work ? #568

Closed
FHedin opened this Issue Jan 24, 2018 · 4 comments

Comments

Projects
None yet
3 participants
@FHedin
Copy link

FHedin commented Jan 24, 2018

Hi,

I am using your amazing Sol2 wrapper in a scientific software, and I would like to know how to cite your work in a scientific article: should I just link to your GitHub, or is there any official publication to cite ? Like a conference paper/presentation to reference ?

For example I saw the following 2 presentations:

https://github.com/ThePhD/sol2/blob/develop/docs/presentations/ThePhD%20-%20No%20Overhead%20C%20Abstraction%20-%202016.10.14.pdf

https://github.com/ThePhD/sol2/blob/develop/docs/presentations/ThePhD%20-%20Wrapping%20Lua%20C%20in%20C%2B%2B%20-%202017.11.8.pdf

Are they referenced somewhere with a D.O.I. number ?

Once again thanks for this work.

Regards,

FHedin

@ThePhD

This comment has been minimized.

Copy link
Owner

ThePhD commented Jan 24, 2018

Thank you for choosing sol2 for your work!

I have not yet gone through with fully publishing a paper (the one I worked on for a class is way too terrible to publish and needs a lot of work before I make it journal/publication-ready), so I do not have a DOI number associated with sol2.

But!

It would be of immense help if you cited sol2 including information like so:

ThePhD (2018). sol2: a C++ <-> Lua API wrapper (Version 2.19.0) [Software]. Available from https://github.com/ThePhD/sol2.

Particularly, if you want people to reproduce your work you should definitely include the version number and the link. This will make it so someone doesn't pick up vLatest 2 years from now when we're on sol 3.8.1, while your paper used 2.19.0 (or perhaps an earlier version). Your journal may have additional guidelines about what to do for citing software, but the above citation is succinct, compact and provides pretty much all the necessary information.

Best of luck with your software and research!

@ThePhD ThePhD self-assigned this Jan 24, 2018

@ThePhD ThePhD added this to the Documentation milestone Jan 24, 2018

@FHedin

This comment has been minimized.

Copy link

FHedin commented Jan 24, 2018

Thanks, it is my pleasure to cite such a nice piece of code ;-)

here is a template for a BibTeX citing entry:

@misc{sol2,
author = {ThePhD},
title = {sol2: a C++ {$<$-$>$} Lua API wrapper (Version 2.17.5)},
howpublished = {[Software]},
month = {June},
year = {2017},
url = {https://github.com/ThePhD/sol2},
note = {https://github.com/ThePhD/sol2}
}

Adjust date and version number as required

Which renders as (LaTeX template for: American Institude of Physics, Journal of Chemical Physics):

image

I hope more people will use Lua/LuaJIT combined to Sol2 within the scientific computing community: there are really cool things to do, I have a core program in C++ std14, and I let the user define several Lua functions for a tunable part of the algorithm, wrap them using sol::function and call them within C++: i do this for a code running on a HPC architecture with hundreds of MPI replicas and it works perfectly ;-)

And I do confirm that the overhead I observe when profiling the code is 0 or almost.

My project should be released open source within the next month on github, @ThePhD you can be sure that I will reference your repository !

I wish you the best for the future,

FHedin

@ThePhD

This comment has been minimized.

Copy link
Owner

ThePhD commented Jan 24, 2018

Awesome! When it's published, I'll make sure to drop a link in the "mentions" page on the docs, and link to your paper and repo! http://sol2.readthedocs.io/en/latest/mentions.html

@ThePhD ThePhD closed this Jan 24, 2018

@Nava2

This comment has been minimized.

Copy link
Contributor

Nava2 commented Jan 25, 2018

These are two examples that I used in my thesis work,

@online{GitHub:ThePhD:sol2,
    title = {The{P}h{D} / sol2},
    subtitle = {a bi-directional {C}++ to Lua API wrapper with advanced features and top-notch performance},
    date = {2016-08-22},
    url = {https://github.com/ThePhD/sol2/tree/ffe6e79f97},
    urlDate = {2017-07-22},
}

@online{GitHub:ThePhD:sol2:issue:126,
    title = {The{P}h{D} / sol2},
    subtitle = {{Long compilation times when registering usertype with lots ({\textgreater}50) of member functions. - \#126}},
    date = {2016-06-22},
    url = {https://github.com/ThePhD/sol2/issues/126},
    urlDate = {2017-07-26},
}

Not sure if that's helpful at all. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment