Skip to content

Commit

Permalink
HowTo setup ZnDraw (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
PythonFZ authored Dec 5, 2024
1 parent 8105345 commit 2397d01
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/concept/zndraw.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ You can find more information in the GUI by clicking on :code:`Python Access`.
The :code:`vis` object behaves like a list of :term:`ASE` atom objects.
Modifying them in place, will be reflected in real-time on the GUI.

.. tip::

You can keep a ZnDraw instance running in the background and set the environment variable :code:`ZNDRAW_URL` to the URL of the running instance.
This way, you do not have to define a ZnDraw url when running ZnDraw or ``mlipx`` CLI commands.
You can also setup a `ZnDraw Docker container <https://github.com/zincware/ZnDraw?tab=readme-ov-file#self-hosting>`_ to always have a running instance.

.. code:: python
from zndraw import ZnDraw
Expand Down

0 comments on commit 2397d01

Please sign in to comment.