Docs update

pace-neutrons · Oct 22, 2024 · b29947c · b29947c
1 parent 5f66652
commit b29947c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/doc/source/python-api.rst b/doc/source/python-api.rst
@@ -20,3 +20,4 @@ Python API
   sampling
   utils
   Interpolation with Brille <brille-interpolator>
+  writers
diff --git a/doc/source/writers.rst b/doc/source/writers.rst
@@ -0,0 +1,15 @@
+.. _writers:
+
+===========================
+Writing to external formats
+===========================
+
+Phonon website visualisation
+----------------------------
+
+The `phonon visualisation website <https://henriquemiranda.github.io/phononwebsite/phonon.html>`_ is a useful tool for the interpretation of phonon band structures with related eigenvectors.
+A :class:`QpointPhononModes <euphonic.qpoint_phonon_modes.QpointPhononModes>` object can be combined with a corresponding set of :math:`\mathbf{q}`-point labels to write an appropriate JSON file, which is importable as a "custom file".
+
+.. autofunction:: euphonic.writers.phonon_website.write_phonon_website_json
+
+
diff --git a/euphonic/writers/phonon_website.py b/euphonic/writers/phonon_website.py
@@ -59,6 +59,8 @@ def write_phonon_website_json(
 
     Parameters
     ----------
+    modes
+        Phonon frequencies and eigenvectors along q-point path
     output_file
         Path to output file
     name
-Original file line number
+Diff line change
@@ Expand Up / @@ -20,3 +20,4 @@ Python API @@
       sampling
       utils
       Interpolation with Brille <brille-interpolator>
+      writers