Merge pull request #40 from SMTG-UCL/develop

add JOSS badge to readme/docs

CHANGELOG.rst

@@ -1,11 +1,18 @@
 Change Log
 ==========
 
+v22.12.2
+--------
+
+- Add JOSS badge to docs
+
+
 v22.12.1
 --------
 
 - Minor updates to paper.md and paper.bib
 
+
 v22.11.29
 --------
 

README.md

@@ -1,8 +1,8 @@
 [![Build status](https://github.com/SMTG-UCL/ShakeNBreak/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/SMTG-UCL/ShakeNBreak/actions)
 [![Documentation Status](https://readthedocs.org/projects/shakenbreak/badge/?version=latest&style=flat)](https://shakenbreak.readthedocs.io/en/latest/)
 [![arXiv](https://img.shields.io/badge/arXiv-2207.09862-b31b1b.svg)](https://arxiv.org/abs/2207.09862)
+[![JOSS](https://joss.theoj.org/papers/10.21105/joss.04817/status.svg)](https://doi.org/10.21105/joss.04817)
 [![PyPI](https://img.shields.io/pypi/v/shakenbreak)](https://pypi.org/project/shakenbreak)
-[![status](https://joss.theoj.org/papers/6545bcc1a0439b16360ace684ac5aa25/status.svg)](https://joss.theoj.org/papers/6545bcc1a0439b16360ace684ac5aa25)
 [![Downloads](https://img.shields.io/pypi/dm/shakenbreak)](https://shakenbreak.readthedocs.io/en/latest/)
 <!--- add JOSS DOI badge here when ready, and published arxiv. Also update pypi package [![DOI]...-->
 

docs/conf.py

@@ -25,7 +25,7 @@
 author = 'Irea Mosquera-Lois, Seán R. Kavanagh'
 
 # The full version, including alpha/beta/rc tags
-release = '22.12.1'
+release = '22.12.2'
 
 
 # -- General configuration ---------------------------------------------------

docs/index.rst

@@ -15,8 +15,8 @@
 .. image:: https://img.shields.io/pypi/v/shakenbreak
  :target: https://pypi.org/project/shakenbreak
 
-.. image:: https://joss.theoj.org/papers/6545bcc1a0439b16360ace684ac5aa25/status.svg
- :target: https://joss.theoj.org/papers/6545bcc1a0439b16360ace684ac5aa25
+.. image:: https://joss.theoj.org/papers/10.21105/joss.04817/status.svg
+   :target: https://doi.org/10.21105/joss.04817
 
 .. image:: https://img.shields.io/pypi/dm/shakenbreak
  :target: https://shakenbreak.readthedocs.io/en/latest/

setup.py

@@ -131,7 +131,7 @@ def package_files(directory):
 
 setup(
     name="shakenbreak",
-    version="22.12.1",
+    version="22.12.2",
     description="Package to generate and analyse distorted defect structures, in order to "
     "identify ground-state and metastable defect configurations.",
     long_description="Python package to automatise the process of defect structure searching. "