Skip to content

Commit

Permalink
Fix reciprocal cell CLI documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
utf committed Mar 13, 2021
1 parent 0ecea35 commit 9a57a0a
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions docs/src/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -250,14 +250,22 @@ 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:

.. image:: _static/fs-1.jpg
: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
~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 9a57a0a

Please sign in to comment.