search

xtensor-stack / xtensor

C++ tensors with broadcasting and lazy computing
BSD 3-Clause "New" or "Revised" License
3.37k stars 400 forks source link

How to cite xtensor? #2320

Open AntoinePrv opened 3 years ago

AntoinePrv commented 3 years ago

With every successful project, eventually comes this issue 🌟

Certain fields do try to make a reference for software, even if it was not academically published. I personally believe it is important to emphasize the importance of software in research/academia.

So far I have transformed the information in the copyright

@manual{xtensor,
    title = {xtensor: Multi-dimensional arrays with broadcasting and lazy computing},
    author = {Johan Mabille and Sylvain Corlay and Wolf Vollprecht},
    url = {https://github.com/xtensor-stack/xtensor},
    year={2016},
}

which seems to be the approach taken by PyBind. Another possibility would be to make a Zenodo entry, e.g. seaborn.

JohanMabille commented 3 years ago

First, thank you for citing xtensor!

I think the approach taken by PyBind is good for now, we are thinking of submitting xtensor to JOSS or similar. What is your deadline?

AntoinePrv commented 3 years ago

I'll be submitting soon, but if there is an updated citation during review, I can change it.

hearues-zueke-github commented 1 year ago

Hello, @AntoinePrv: Was the citation enough for your work? I would also like to cite the xtensor library in my thesis. @JohanMabille: According to this question on academia.stackexchange.com, there is now a possibility to add a CITATION.cff file in the root repository (as shown here). I would suggest that referencing the xtensor library will be easier for anyone in the future.

JohanMabille commented 1 year ago

@hearues-zueke-github Thanks for the pointer! Totally agree with your suggestion, I will add a citation file to the repo.