From 9a57a0ae5b957624f1e0e1a5ca529f9629334e75 Mon Sep 17 00:00:00 2001 From: Alex Ganose Date: Fri, 12 Mar 2021 16:27:04 -0800 Subject: [PATCH] Fix reciprocal cell CLI documentation --- docs/src/cli.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/src/cli.rst b/docs/src/cli.rst index ea13f479..11e651d2 100644 --- a/docs/src/cli.rst +++ b/docs/src/cli.rst @@ -204,11 +204,11 @@ Reciprocal space By default, the Wigner–Seitz cell is used to contain to the Fermi surface. The parallelepiped reciprocal lattice cell can be used instead by selecting the -``--reciprocal-cell`` option (``-r``). For example: +``--no-wigner`` option. For example: .. code-block:: bash - ifermi plot --reciprocal-cell + ifermi plot --no-wigner Visualisation options @@ -250,7 +250,8 @@ file can be specified using the ``--output`` (``-o``) option. For example: .. NOTE:: - Saving output files with the plotly backend requires plotly-orca to be installed. + Saving graphical output files with the plotly backend requires plotly-orca to be + installed. Running the above command in the ``examples/MgB2`` directory produces the plot: @@ -258,6 +259,13 @@ Running the above command in the ``examples/MgB2`` directory produces the plot: :height: 250px :align: center +Interactive plots can be saved to a html file using the plotly backend by specifying +a html filename. This will prevent the plot from being opened automatically. + +.. code-block:: bash + + ifermi plot --output fermi-surface.html + Selecting spin channels ~~~~~~~~~~~~~~~~~~~~~~~