add links to JOSS paper

otvam · otvam · commit 4e746dc70a8d · 2025-09-03T10:48:48.000-04:00
diff --git a/README.md b/README.md
@@ -5,14 +5,15 @@
 [![python 3](https://img.shields.io/badge/python_3-orange)](https://www.python.org/downloads)
 [![MPL-2.0](https://img.shields.io/badge/MPL--2.0-orange)](http://mozilla.org/MPL/2.0)
 [![git / repo](https://img.shields.io/badge/git-repo-yellow)](https://github.com/otvam/pypeec)
-[![doi / cite](https://img.shields.io/badge/doi-cite-yellow)](https://doi.org/10.5281/zenodo.14941571)
+[![paper / 10.21105/joss.06644](https://img.shields.io/badge/paper-10.21105/joss.06644-yellow)](https://doi.org/10.21105/joss.06644)
 [![doc / sphinx](https://img.shields.io/badge/doc-sphinx-yellow)](https://pypeec.otvam.ch)
 [![pypi / pkg](https://img.shields.io/pypi/v/pypeec?label=pypi&color=green)](https://pypi.org/project/pypeec)
 [![conda / pkg](https://img.shields.io/conda/v/conda-forge/pypeec?label=conda&color=green)](https://anaconda.org/conda-forge/pypeec)
 
 ---
 * **Website: [pypeec.otvam.ch](https://pypeec.otvam.ch)**
 * **Repository: [github.com/otvam/pypeec](https://github.com/otvam/pypeec)**
+* **Paper: [doi.org/10.21105/joss.06644](https://doi.org/10.21105/joss.06644)**
 * **Conda: [anaconda.org/conda-forge/pypeec](https://anaconda.org/conda-forge/pypeec)**
 * **PyPI: [pypi.org/project/pypeec](https://pypi.org/project/pypeec)**
 ---
@@ -80,6 +81,8 @@ For such cases, PyPEEC can be very slow and consume a lot of memory.
 
   * [Website](https://pypeec.otvam.ch)
   * [Repository](https://github.com/otvam/pypeec)
+  * [Paper](https://doi.org/10.21105/joss.06644)
+  * [Citation](https://doi.org/10.21105/joss.06644)
   * [Issues](https://github.com/otvam/pypeec/issues)
 
 * **Releases**
diff --git a/docs/content/about.rst b/docs/content/about.rst
@@ -9,33 +9,35 @@ About
 Links
 -----
 
-=============  ==========================================
-Website        https://pypeec.otvam.ch
-Repository     https://github.com/otvam/pypeec
-Issues         https://github.com/otvam/pypeec/issues
-=============  ==========================================
+===============  ==========================================
+Website          https://pypeec.otvam.ch
+Repository       https://github.com/otvam/pypeec
+Paper            https://doi.org/10.21105/joss.06644
+Citation         https://doi.org/10.21105/joss.06644
+Issues           https://github.com/otvam/pypeec/issues
+===============  ==========================================
 
 Maintainer
 ----------
 
-=============  ==========================================
-Name           **Thomas Guillod**
-Affiliation    Dartmouth College
-Email          guillod@otvam.ch
-Website        https://otvam.ch
-=============  ==========================================
+===============  ==========================================
+Name             **Thomas Guillod**
+Affiliation      Dartmouth College
+Email            guillod@otvam.ch
+Website          https://otvam.ch
+===============  ==========================================
 
 Release
 -------
 
-=============  ==========================================
-Package        **pypeec**
-Version        |ver| / |date|
-PyPI           https://pypi.org/project/pypeec
-Conda          https://anaconda.org/conda-forge/pypeec
-GitHub         https://github.com/otvam/pypeec/releases
-Zenodo         https://doi.org/10.5281/zenodo.14941571
-=============  ==========================================
+===============  ==========================================
+Package          **pypeec**
+Version          |ver| / |date|
+PyPI             https://pypi.org/project/pypeec
+Conda            https://anaconda.org/conda-forge/pypeec
+GitHub           https://github.com/otvam/pypeec/releases
+Zenodo           https://doi.org/10.5281/zenodo.14941571
+===============  ==========================================
 
 Authors
 -------
diff --git a/docs/images/badge_doi.svg b/docs/images/badge_doi.svg
diff --git a/docs/images/badge_paper.svg b/docs/images/badge_paper.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="170" height="20" role="img" aria-label="paper: 10.21105/joss.06644"><title>paper: 10.21105/joss.06644</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="170" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="41" height="20" fill="#555"/><rect x="41" width="129" height="20" fill="#dfb317"/><rect width="170" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="215" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="310">paper</text><text x="215" y="140" transform="scale(.1)" fill="#fff" textLength="310">paper</text><text aria-hidden="true" x="1045" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="1190">10.21105/joss.06644</text><text x="1045" y="140" transform="scale(.1)" fill="#fff" textLength="1190">10.21105/joss.06644</text></g></svg>
diff --git a/docs/index.rst b/docs/index.rst
@@ -52,9 +52,9 @@ The code is written in **Python** and is fully **open source**!
    :target: https://github.com/otvam/pypeec
    :alt: git / repo
 
-.. image:: images/badge_doi.svg
-   :target: https://doi.org/10.5281/zenodo.14941571
-   :alt: doi / cite
+.. image:: images/badge_paper.svg
+   :target: https://doi.org/10.21105/joss.06644
+   :alt: paper / 10.21105/joss.06644
 
 .. image:: images/badge_doc.svg
    :target: https://pypeec.otvam.ch
@@ -71,6 +71,7 @@ The code is written in **Python** and is fully **open source**!
 .. important::
     * **Website:** `pypeec.otvam.ch <https://pypeec.otvam.ch>`__
     * **Repository:** `github.com/otvam/pypeec <https://github.com/otvam/pypeec>`__
+    * **Paper:** `doi.org/10.21105/joss.06644 <https://doi.org/10.21105/joss.06644>`__
     * **Conda:** `anaconda.org/conda-forge/pypeec <https://anaconda.org/conda-forge/pypeec>`__
     * **PyPI:** `pypi.org/project/pypeec <https://pypi.org/project/pypeec>`__
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -79,6 +79,7 @@ Homepage = "https://pypeec.otvam.ch"
 Repository = "https://github.com/otvam/pypeec"
 Releases = "https://github.com/otvam/pypeec/releases"
 Issues = "https://github.com/otvam/pypeec/issues"
+Paper = "https://doi.org/10.21105/joss.06644"
 
 [project.readme]
 file = "README.md"
