search

TA-Lib / ta-lib-python

Python wrapper for TA-Lib (http://ta-lib.org/).
http://ta-lib.github.io/ta-lib-python
Other
9.81k stars 1.78k forks source link

I want to cite this Github repository. #545

Open SCH-YcHan opened 2 years ago

SCH-YcHan commented 2 years ago

Hello, I am a graduate student doing stock research. I have done study on predicting stock price trends using ta-lib and I am currently writing a paper. However, I couldn't find any Citation File Format (CFF) files in this repository. I am currently writing a paper in the Overleaf environment and would like to cite it in BibTeX format.

So I want to write BibTeX in the format below, is this the right format?

@misc{ta-lib2022, author = {John Benediktsson}, title = {ta-lib}, year = {2022}, publisher = {GitHub}, journal = {GitHub repository}, howpublished = {\url{[https://github.com/mrjbq7/ta-lib]}} }

mrjbq7 commented 2 years ago

There are multiple contributors, and it was released before 2022, but I'm not familiar enough with how citations for software projects are done... what do you suggest?

mrjbq7 commented 2 years ago

I added a minimal CITATION.cff file just now, but I don't know how best to include multiple contributors or other fields... suggestions welcome.

85569d04a5b2541c5a277f984bf19d0874d17a0b

SCH-YcHan commented 2 years ago

Thank you so much for adding the CFF file.

The CFF file format is usually written like the URL below: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

The doi of the CFF file can be issued at the following URL: https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content

Also, you can easily create a CFF file through the URL below: https://citation-file-format.github.io/cff-initializer-javascript/#/

It may be a little cumbersome, but once you make it, researchers can easily cite this repository.