diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..0ae6c31 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,27 @@ +cff-version: 1.2.0 +title: tclf +message: >- + If you use this software, please cite it using the + metadata from this file. +type: software +authors: + - given-names: Markus + family-names: Bilz + email: web@markusbilz.com + orcid: 'https://orcid.org/0009-0009-6833-4393' +repository-code: 'https://github.com/KarelZe/tclf' +url: 'https://karelze.github.io/tclf/' +abstract: >- + `tclf` is a scikit-learn-compatible implementation of + trade classification algorithms to classify financial + markets transactions into buyer- and seller-initiated + trades. +keywords: + - clnv + - lee-ready + - rule-based classifier + - scikit-learn + - trade-classification +license: BSD 3 +version: 0.0.1 +date-released: '2023-12-04' diff --git a/README.md b/README.md index 3189344..c38dbac 100644 --- a/README.md +++ b/README.md @@ -97,6 +97,20 @@ Like before, column/feature names must follow our [naming conventions](https://k - Depth rule - Tradesize rule +## Citation + +```latex +@software{Bilz_tclf_2023, + author = {Bilz, Markus}, + license = {BSD 3}, + month = dec, + title = {{tclf}}, + url = {https://github.com/KarelZe/tclf}, + version = {0.0.1}, + year = {2023} +} +``` + ## References
diff --git a/docs/index.md b/docs/index.md index 3189344..c38dbac 100644 --- a/docs/index.md +++ b/docs/index.md @@ -97,6 +97,20 @@ Like before, column/feature names must follow our [naming conventions](https://k - Depth rule - Tradesize rule +## Citation + +```latex +@software{Bilz_tclf_2023, + author = {Bilz, Markus}, + license = {BSD 3}, + month = dec, + title = {{tclf}}, + url = {https://github.com/KarelZe/tclf}, + version = {0.0.1}, + year = {2023} +} +``` + ## References