From 2397d0150c2a4c76d2ed6b45d28c117bcabca5f4 Mon Sep 17 00:00:00 2001 From: Fabian Zills <46721498+PythonFZ@users.noreply.github.com> Date: Thu, 5 Dec 2024 13:04:44 +0100 Subject: [PATCH] HowTo setup ZnDraw (#38) --- docs/source/concept/zndraw.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/concept/zndraw.rst b/docs/source/concept/zndraw.rst index 3228a8e..08d83aa 100644 --- a/docs/source/concept/zndraw.rst +++ b/docs/source/concept/zndraw.rst @@ -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 `_ to always have a running instance. + .. code:: python from zndraw import ZnDraw