From ffd4b199bedad53efd209c27ff8b0de4780607fc Mon Sep 17 00:00:00 2001 From: Volkan Kumtepeli Date: Sat, 7 Sep 2024 21:11:47 +0100 Subject: [PATCH] Updated JOSS paper and citation info --- .github/workflows/documentation.yml | 20 +++++++-------- CITATION.cff | 40 +++++++++++++++++++++++++++++ README.md | 1 + docs/5_publications/joss_paper.md | 28 +++++++++++++++++--- 4 files changed, 76 insertions(+), 13 deletions(-) create mode 100644 CITATION.cff diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 68579d5..58933e3 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -91,18 +91,18 @@ jobs: working-directory: build_dir - run: sudo mv ./build_dir/Coverage ./_site/Coverage - # JOSS Paper Compilation Steps - - name: Build draft PDF for JOSS paper - uses: openjournals/openjournals-draft-action@master - with: - journal: joss - paper-path: joss/paper.md + # # JOSS Paper Compilation Steps + # - name: Build draft PDF for JOSS paper + # uses: openjournals/openjournals-draft-action@master + # with: + # journal: joss + # paper-path: joss/paper.md - - name: Create directory for JOSS paper - run: sudo mkdir -p ./_site/pub + # - name: Create directory for JOSS paper + # run: sudo mkdir -p ./_site/pub - - name: Move JOSS paper to documentation - run: sudo mv ./joss/paper.pdf ./_site/pub/joss.pdf + # - name: Move JOSS paper to documentation + # run: sudo mv ./joss/paper.pdf ./_site/pub/joss.pdf # Upload the website: - name: Upload artifact diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..a8ab614 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,40 @@ +cff-version: "1.2.0" +authors: +- family-names: Kumtepeli + given-names: Volkan + orcid: "https://orcid.org/0000-0003-2392-9771" +- family-names: Perriment + given-names: Rebecca + orcid: "https://orcid.org/0009-0003-2781-0724" +- family-names: Howey + given-names: David A. + orcid: "https://orcid.org/0000-0002-0620-3955" +doi: 10.5281/zenodo.13551469 +message: If you use this software, please cite our article in the + Journal of Open Source Software. +preferred-citation: + authors: + - family-names: Kumtepeli + given-names: Volkan + orcid: "https://orcid.org/0000-0003-2392-9771" + - family-names: Perriment + given-names: Rebecca + orcid: "https://orcid.org/0009-0003-2781-0724" + - family-names: Howey + given-names: David A. + orcid: "https://orcid.org/0000-0002-0620-3955" + date-published: 2024-09-06 + doi: 10.21105/joss.06881 + issn: 2475-9066 + issue: 101 + journal: Journal of Open Source Software + publisher: + name: Open Journals + start: 6881 + title: "DTW-C++: Fast dynamic time warping and clustering of time + series data" + type: article + url: "https://joss.theoj.org/papers/10.21105/joss.06881" + volume: 9 +title: "DTW-C++: Fast dynamic time warping and clustering of time series + data" \ No newline at end of file diff --git a/README.md b/README.md index fd7577b..167b70d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ DTW-C++ =========================== +[![DOI](https://joss.theoj.org/papers/10.21105/joss.06881/status.svg)](https://doi.org/10.21105/joss.06881) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.13551469.svg)](https://doi.org/10.5281/zenodo.13551469) [![Ubuntu unit](https://github.com/Battery-Intelligence-Lab/dtw-cpp/workflows/Ubuntu%20unit/badge.svg)](https://github.com/Battery-Intelligence-Lab/dtw-cpp/actions) diff --git a/docs/5_publications/joss_paper.md b/docs/5_publications/joss_paper.md index 31cbfa3..0ad9d26 100644 --- a/docs/5_publications/joss_paper.md +++ b/docs/5_publications/joss_paper.md @@ -3,11 +3,33 @@ layout: default title: JOSS article nav_order: 2 --- - + + - JOSS article + + + JOSS Article + - +

JOSS Article

+

For detailed information, please visit: + + DOI badge + +

+ \ No newline at end of file