Skip to content

Commit

Permalink
Add citation file (#10)
Browse files Browse the repository at this point in the history
* Add citation file

* Add recommended citation to readme/index.md
  • Loading branch information
KarelZe authored Dec 4, 2023
1 parent add21ca commit 1f07850
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 0 deletions.
27 changes: 27 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -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: [email protected]
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'
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<div class="csl-bib-body" style="line-height: 2; margin-left: 2em; text-indent:-2em;">
Expand Down
14 changes: 14 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<div class="csl-bib-body" style="line-height: 2; margin-left: 2em; text-indent:-2em;">
Expand Down

0 comments on commit 1f07850

Please sign in to comment.