Add links and notes for polarons example

SMTG-Bham · Feb 6, 2025 · bf4bead · bf4bead
1 parent 7947781
commit bf4bead
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -58,7 +58,7 @@ The font Montserrat ([Open Font License](https://scripts.sil.org/cms/scripts/pag
 ## Usage
 
 ### Python API
-`ShakeNBreak` can be used through a Python API, as exemplified in the [SnB Python API tutorial](https://shakenbreak.readthedocs.io/en/latest/ShakeNBreak_Example_Workflow.html), with more info available on the [docs](https://readthedocs.org/projects/shakenbreak).
+`ShakeNBreak` can be used through a Python API, as exemplified in the [SnB Python API tutorial](https://shakenbreak.readthedocs.io/en/latest/ShakeNBreak_Example_Workflow.html), with more info available on the [docs](https://shakenbreak.readthedocs.io).
 
 ### Command line interface
 Alternatively, the code can be used via the command line:

diff --git a/docs/ShakeNBreak_Example_Workflow.ipynb b/docs/ShakeNBreak_Example_Workflow.ipynb
@@ -34,7 +34,12 @@
     "- Parse the geometry relaxation results\n",
     "- Re-generate any energy-lowering distortions found for _some_ (but not all) charge states for a given defect\n",
     "- Plot the final energies to demonstrate what energy-lowering defect distortions have been identified\n",
-    "- Then continue our defect calculations, confident we have obtained the ground-state structures. "
+    "- Then continue our defect calculations, confident we have obtained the ground-state structures.\n",
+    "\n",
+    "\n",
+    "```{tip}\n",
+    "`ShakeNBreak` can also be used to search for other energy-lowering distortions / localised species, such as polarons and self-trapped excitons. An example of using `ShakeNBreak` for this application is shown in the [SnB Polarons Tutorial](https://shakenbreak.readthedocs.io/en/latest/ShakeNBreak_Polaron_Workflow.html).\n",
+    "```"
    ]
   },
   {

diff --git a/docs/Tutorials.rst b/docs/Tutorials.rst
@@ -6,12 +6,15 @@ Tutorials
 Python API
 ----------
 Usage of ShakeNBreak from a Python API is exemplified in the
-`SnB Python API Tutorial <https://shakenbreak.readthedocs.io/en/latest/ShakeNBreak_Example_Workflow.html>`_, which includes:
+`SnB Python API Tutorial <https://shakenbreak.readthedocs.io/en/latest/ShakeNBreak_Example_Workflow.html>`_
+and `SnB Polarons Tutorial <https://shakenbreak.readthedocs.io/en/latest/ShakeNBreak_Polaron_Workflow.html>`_,
+which include:
 
 .. toctree::
    :maxdepth: 2
 
    ShakeNBreak_Example_Workflow
+   ShakeNBreak_Polaron_Workflow
 
 
 Command line interface (CLI)

diff --git a/docs/index.rst b/docs/index.rst
@@ -107,7 +107,10 @@ Usage
 Python API
 ----------------
 
-``ShakeNBreak`` can be used through a Python API, as exemplified in the `SnB Python API Tutorial <https://shakenbreak.readthedocs.io/en/latest/ShakeNBreak_Example_Workflow.html>`_.
+``ShakeNBreak`` can be used through a Python API, as exemplified in the
+`SnB Python API Tutorial <https://shakenbreak.readthedocs.io/en/latest/ShakeNBreak_Example_Workflow.html>`_
+and
+`SnB Polarons Tutorial <https://shakenbreak.readthedocs.io/en/latest/ShakeNBreak_Polaron_Workflow.html>`_.
 
 Command line interface
 -------------------------