Updated JOSS paper and citation info

Battery-Intelligence-Lab · Sep 7, 2024 · ffd4b19 · ffd4b19
1 parent 4eae280
commit ffd4b19
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 13 deletions.
diff --git 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
@@ -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"
diff --git 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
@@ -3,11 +3,33 @@ layout: default
 title: JOSS article
 nav_order: 2
 ---
-<html>
+<!DOCTYPE html>
+<html lang="en">
 <head>
-    <title>JOSS article</title>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>JOSS Article</title>
+    <style>
+        body {
+            font-family: Arial, sans-serif;
+            line-height: 1.6;
+            padding: 20px;
+        }
+        iframe {
+            display: block;
+            width: 100%;
+            height: calc(100vh - 100px);
+            border: none;
+        }
+    </style>
 </head>
 <body>
-    <iframe src="https://battery-intelligence-lab.github.io/dtw-cpp/pub/joss.pdf" frameborder="0" scrolling="yes" seamless="seamless" style="display:block; width:100%; height:100vh;"></iframe>
+    <h1>JOSS Article</h1>
+    <p>For detailed information, please visit: 
+        <a href="https://doi.org/10.21105/joss.06881" target="_blank">
+            <img src="https://joss.theoj.org/papers/10.21105/joss.06881/status.svg" alt="DOI badge">
+        </a>
+    </p>
+    <iframe src="https://www.theoj.org/joss-papers/joss.06881/10.21105.joss.06881.pdf"></iframe>
 </body>
 </html>