From 44f3142bfb73d682e9dc093ecf3932e21f5918c6 Mon Sep 17 00:00:00 2001 From: Simon Brugman Date: Tue, 12 Jul 2022 16:50:01 -0500 Subject: [PATCH] docs(readme): include citation information (#241) --- CITATION.cff | 27 +++++++++++++++++++++++++++ README.rst | 22 ++++++++++++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 CITATION.cff diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 00000000..a2c6106b --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,27 @@ +type: proceedings +title: "popmon: Analysis Package for Dataset Shift Detection" +authors: +- family-names: Brugman + given-names: Simon +- family-names: Sostak + given-names: Tomas +- family-names: Pradyot + given-names: Patil +- family-names: Baak + given-names: Max +year: "2022" +collection-title: "Proceedings of the 21st Python in Science Conference" +editors: +- family-names: Agarwal + given-names: Meghann +- family-names: Calloway + given-names: Chris +- family-names: Niederhut + given-names: Dillon +- family-names: Shupe + given-names: David +start: '161' +end: '168' +conference: + name: "Python in Science Conference" + address: "Austin, Texas" \ No newline at end of file diff --git a/README.rst b/README.rst index 1fc97762..c1a0701e 100644 --- a/README.rst +++ b/README.rst @@ -252,6 +252,28 @@ Project contributors This package was authored by ING Wholesale Banking Advanced Analytics. Special thanks to the following people who have contributed to the development of this package: `Ahmet Erdem `_, `Fabian Jansen `_, `Nanne Aben `_, Mathieu Grimal. + +Citing popmon +============= +If ``popmon`` has been relevant in your work, and you would like to acknowledge the project in your publication, we suggest citing the following paper: + +* Brugman, S., Sostak, T., Patil, P., Baak, M. *popmon: Analysis Package for Dataset Shift Detection*. Proceedings of the 21st Python in Science Conference. 161-168 (2022). (`link `_) + +*In BibTeX format:* + +.. code-block:: bibtex + + @InProceedings{ popmon-proc-scipy-2022, + author = { {S}imon {B}rugman and {T}omas {S}ostak and {P}radyot {P}atil and {M}ax {B}aak }, + title = { popmon: {A}nalysis {P}ackage for {D}ataset {S}hift {D}etection }, + booktitle = { {P}roceedings of the 21st {P}ython in {S}cience {C}onference }, + pages = { 161 - 168 }, + year = { 2022 }, + editor = { {M}eghann {A}garwal and {C}hris {C}alloway and {D}illon {N}iederhut and {D}avid {S}hupe }, + } + + + Contact and support ===================