Skip to content

Commit

Permalink
Add citation to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
vnmabus committed Feb 3, 2023
1 parent 068a20b commit fe0a4de
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ identifiers:
- description: "This is the archived snapshot of version 0.5 of dcor"
type: doi
value: 10.5281/zenodo.3996697
- description: "This is the archived snapshot of version 0.6 of dcor"
type: doi
value: 10.5281/zenodo.7484447
preferred-citation:
type: article
title: "dcor: Distance correlation and energy statistics in Python"
Expand Down
26 changes: 26 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,32 @@ The package dcor depends on the following libraries:
- scipy
- joblib

Citing dcor
===========
Please, if you find this software useful in your work, reference it citing the following paper:

@article{ramos-carreno+torrecilla_2023_dcor,
author = {Ramos-Carreño, Carlos and Torrecilla, José L.},
doi = {10.1016/j.softx.2023.101326},
journal = {SoftwareX},
month = {2},
title = {{dcor: Distance correlation and energy statistics in Python}},
url = {https://www.sciencedirect.com/science/article/pii/S2352711023000225},
volume = {22},
year = {2023},
}

You can additionally cite the software repository itself using:

@misc{ramos-carreno_2022_dcor,
author = {Ramos-Carreño, Carlos},
doi = {10.5281/zenodo.3468124},
month = {3},
title = {dcor: distance correlation and energy statistics in Python},
url = {https://github.com/vnmabus/dcor},
year = {2022}
}

Documentation
=============
The documentation can be found in https://dcor.readthedocs.io/en/latest/?badge=latest
Expand Down

0 comments on commit fe0a4de

Please sign in to comment.