Add announcement about WULFRIC

docs/source/announcement.rst

@@ -0,0 +1,44 @@
+.. _announcement:
+
+*****************
+RAD-tools splits!
+*****************
+
+**DATE: 11.12.2023**
+
+Part of the RAD-tools package is separated into a standalone package called
+`WULFRIC <https://wulfric.org>`_.
+The functionality connected with Crystal, Lattice, Atom, Kpoints is moved into WULFRIC.
+
+At the moment the source code of RAD-tools is not changed, but in the future
+moved part is going to be removed from it and replaced with the dependency on WULFRIC.
+
+The reason for this change is that the functionality of Crystal, Lattice, Atom, Kpoints is
+useful not only for the RAD-tools, but also for other packages.
+
+If you are using RAD-tools only with scripts, you do not need to change anything.
+
+Below is the comparison table, which guides the transition if you are using RAD-tools as
+a Python package.
+
++---------------------------------------+---------------------------------------+
+| RAD-tools                             | WULFRIC                               |
++=======================================+=======================================+
+| import radtools as rad                | import wulfric as wulf                |
++---------------------------------------+---------------------------------------+
+| from radtools import Crystal          | from wulfric import Crystal           |
++---------------------------------------+---------------------------------------+
+| from radtools import Lattice          | from wulfric import Lattice           |
++---------------------------------------+---------------------------------------+
+| from radtools import Atom             | from wulfric import Atom              |
++---------------------------------------+---------------------------------------+
+| from radtools import Kpoints          | from wulfric import Kpoints           |
++---------------------------------------+---------------------------------------+
+| from radtools import print_2d_array   | from wulfric import print_2d_array    |
++---------------------------------------+---------------------------------------+
+| from radtools import lattice_examples | from wulfric import lattice_examples  |
++---------------------------------------+---------------------------------------+
+| from radtools PlotlyBackend           | from wulfric PlotlyBackend            |
++---------------------------------------+---------------------------------------+
+
+This table is not full, but it should give you an idea how to change your code.

docs/source/conf.py

@@ -1,8 +1,8 @@
 import sys
-from os.path import abspath
 from datetime import datetime
+from os.path import abspath
 
-from radtools import __version__, __release_date__
+from radtools import __release_date__, __version__
 
 sys.path.insert(0, abspath(".."))
 
@@ -102,6 +102,7 @@
     switcher_version = f"{major}.{minor}"
     github_version = "stable"
 html_theme_options = {
+    "announcement": "RAD-tools splits into WULFRIC  <a href='https://rad-tools.org/en/stable/announcement.html'>Read more here</a>",
     "collapse_navigation": True,
     "use_edit_page_button": True,
     "navbar_center": ["version-switcher", "navbar-nav"],

docs/source/index.rst

@@ -13,6 +13,7 @@ RAD-tools
     contribute/index
     cite
     support
+    announcement
 
 :Release: |version|
 :Date: |release_date|
@@ -21,7 +22,8 @@ RAD-tools
 :ref:`Installation <rad-tools_installation>` |
 `Issue Tracker <https://github.com/adrybakov/rad-tools/issues>`_ |
 :ref:`Cite us <rad-tools_cite>` |
-:ref:`support`
+:ref:`support` |
+:ref:`announcement`
 
 .. grid:: 2
 

radtools/__init__.py

@@ -23,7 +23,7 @@
 
 __version__ = "0.8.12"
 __doclink__ = "rad-tools.org"
-__git_hash__ = "a3cdbd0d8329db7bf3cd0315727e1018cae2d4e5"
+__git_hash__ = "c59a9b2bb615c6239aeaaa4b0b73c768f2355eb9"
 __release_date__ = "23 November 2023"