Merge pull request #970 from CSSFrancis/release0160

Release v0.16.0
pyxem · Nov 14, 2023 · f39ebb4 · f39ebb4
2 parents f7f4f6b + eb1a626
commit f39ebb4
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 27 deletions.
diff --git a/.zenodo.json b/.zenodo.json
@@ -8,7 +8,9 @@
       "orcid": "0000-0001-5754-0938"
     },
     {
-      "name":"Magnus Nord"
+      "name":"Magnus Nord",
+      "orcid": "0000-0001-7981-5293",
+      "affiliation": "Norwegian University of Science and Technology"
     },
     {
       "name":"Carter Francis",
@@ -25,32 +27,39 @@
       "name":"Eirik Opheim"
     },
     {
-      "name":"Ben Martineau"
+      "name":"Eric Prestat"
     },
     {
-      "name":"Tina Bergh"
+      "name":"Ben Martineau"
     },
     {
-      "name":"Eric Prestat"
+      "name":"Tina Bergh",
+      "orcid": "0000-0003-3757-3876",
+      "affiliation": "Norwegian University of Science and Technology"
     },
     {
       "name":"Niels Cautaerts",
       "orcid": "0000-0002-6402-9879"
     },
-    {
-      "name":"Stef Smeets"
-    },
     {
       "name":"Håkon Wiik Ånes",
       "orcid": "0000-0002-1213-2911",
       "affiliation": "Norwegian University of Science and Technology"
     },
+    {
+      "name":"Stef Smeets"
+    },
     {
       "name":"Andrew Ross"
     },
     {
       "name":"Joseph Broussard"
     },
+    {
+      "name":"Shuoyuan Huang",
+      "orcid":"0009-0008-9826-9425",
+      "affiliation": "University of Wisconsin Madison"
+    },
     {
       "name":"Sean Collins"
     },
@@ -63,11 +72,6 @@
     {
       "name":"Ida Hjorth"
     },
-    {
-      "name":"Shuoyuan Huang",
-      "orcid":"0009-0008-9826-9425",
-      "affiliation": "University of Wisconsin Madison"
-    },
     {
       "name":"Endre Jacobsen"
     },
@@ -84,14 +88,20 @@
       "name": "Sivert Dagenborg"
     },
     {
-      "name": "Tiarnan Doherty"
+      "name": "Ruben Bjørge",
+      "orcid": "0000-0002-6310-7820",
+      "affiliation": "SINTEF Industry"
+    },
+    {
+      "name":"Affan Iqbal"
     },
     {
       "name":"Jedrzej Morzy"
     },
     {
-      "name":"Affan Iqbal"
+      "name": "Tiarnan Doherty"
     },
+
     {
       "name":"Tomas Ostasevicius"
     },
@@ -104,7 +114,10 @@
     },
     {
       "name":"Rob Tovey"
+    },
+    {
+      "name": "Petr Vacek",
+      "orcid": "0000-0002-1625-9258"
     }
-
   ]
 }
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -8,15 +8,16 @@ The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`
 and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
 
 
-Unreleased
-==========
+2023-11-14 - version 0.16.0
+===========================
 
 Added
 -----
 - Added `magnitude_limits` to `DPCSignal2D` methods (#949)
 - Added :py:class:`~pyxem.signals.LazyCorrelation1D` for lazy Correlation1D signals
 - Improved the documentation and added Examples
 - Add N-D filtering using :py:meth:`~pyxem.signals.Diffraction2D.filter`
+- Add new :py:class:`pyxem.signals.InSituDiffraction2D` class for in-situ diffraction data
 
 Fixed
 -----
@@ -27,9 +28,6 @@ Fixed
   passing orientations as tuples.
 - Fix bug in calculating strain (#958)
 
-Added
------
-- Add n-d and 2-d filters #935 for filtering datasets
 
 2023-05-08 - version 0.15.1
 ===========================

diff --git a/doc/dev_guide/contributing.rst b/doc/dev_guide/contributing.rst
@@ -229,3 +229,36 @@ We use `GitHub Actions <https://github.com/pyxem/pyxem/actions>`_ to ensure that
 can be installed on Windows, macOS and Linux (Ubuntu). After a successful installation,
 the CI server runs the tests. After the tests return no errors, code coverage is
 reported to `Coveralls <https://coveralls.io/github/pyxem/pyxem?branch=main>`_.
+
+Making a release
+================
+
+We use `GitHub Actions <https://github.com/pyxem/pyxem/actions>`_ to automatically
+create a new release. Each time a new tag is pushed to the repository, the CI server
+will:
+
+1. Build the documentation.  Each tagged release will be added as a
+   `stable <https://docs.readthedocs.io/en/stable/versions.html#versioned-documentation>`_ build
+   to `Read the Docs <https://pyxem.readthedocs.io/en/latest/>`_.
+2. Publish a new version of pyxem to `PyPI <https://pypi.org/project/pyxem/>`_.
+3. Create a new `GitHub release <https://github.com/pyxem/pyxem/releases>`_.
+4. Publish a new version of pyxem to `Zenodo <https://zenodo.org/doi/10.5281/zenodo.2649351>`_.
+
+To make a new release, follow these steps:
+
+1. Update the version number in ``release_info.py``.
+2. Update the ``CHANGELOG.rst`` file with the date and new version number and a description of
+   the changes.
+3. Update the list of contributors in both the ``release_info.py`` and ``.zenodo.json``
+   files. __ Make sure that the Zenodo file is valid JSON __.
+4. Commit the changes and push them to the repository.
+5. Create a new tag with the "v" + version number (e.g. "v0.16.0") and make a new release on GitHub.
+6. Wait for the CI server to finish the release process.
+
+Then you can increase the version number in ``release_info.py`` to the next minor version
+and add a dev suffix (e.g. "0.17.dev0").
+
+.. note::
+   If any of the steps fail, you can restart the CI server by clicking on the "Re-run
+   jobs" button on the GitHub Actions page. Sometimes the CI server fails because of
+   connection issues to Zenodo or PyPI.
diff --git a/pyxem/release_info.py b/pyxem/release_info.py
@@ -1,8 +1,8 @@
 name = "pyxem"
-version = "0.16.dev0"
+version = "0.16.0"
 author = "Duncan Johnstone, Phillip Crout, Magnus Nord"
 copyright = "Copyright 2016-2023, The pyxem developers"
-# Contributors listed by original commiter, maintainers, then other
+# Contributors listed by original committer, maintainers, then other
 # within groups organised by  number of commits.
 # See: https://github.com/pyxem/pyxem/graphs/contributors
 credits = [
@@ -13,31 +13,33 @@
     "Joonatan Laulainen",
     "Simon Høgås",
     "Eirik Opheim",
+    "Eric Prestat",
     "Ben Martineau",
     "Tina Bergh",
-    "Eric Prestat",
     "Niels Cautaerts",
-    "Stef Smeets",
     "Håkon Wiik Ånes",
+    "Stef Smeets",
     "Andrew Ross",
     "Joseph Broussard",
+    "Shuoyuan Huang",
     "Sean Collins",
     "Tom Furnival",
     "Daen Jannis",
     "Ida Hjorth",
-    "Shuoyuan Huang",
     "Endre Jacobsen",
     "Mohsen Danaie",
     "Andrew Herzing",
     "Tim Poon",
+    "Sivert Dagenborg",
+    "Ruben Bjørge",
     "Tiarnan Doherty",
-    "Jedrzej Morzy",
     "Affan Iqbal",
+    "Jedrzej Morzy",
     "Tomas Ostasevicius",
     "Tor Inge Thorsen",
     "Matt von Lany",
     "Rob Tovey",
-    "Sivert Dagenborg",
+    "Petr Vacek",
 ]
 license = "GPLv3+"
 maintainer = "Duncan Johnstone, Phillip Crout, Magnus Nord, Carter Francis"