Sisl visualization module and graphical interface

MANIFEST.in

@@ -11,6 +11,7 @@ graft sisl
 
 include sisl/info.py
 
+recursive-include sisl/viz/plotly/gui/build
 recursive-include toolbox *.py *.md README
 
 exclude DEPLOY.md

docs/conf.py

@@ -151,6 +151,7 @@ def __getattr__(cls, name):
     extensions += [
         'sphinx.ext.inheritance_diagram',
         'nbsphinx',
+        'sphinx_gallery.load_style',
         'IPython.sphinxext.ipython_directive',
         'IPython.sphinxext.ipython_console_highlighting',
     ]
@@ -435,7 +436,7 @@ def __getattr__(cls, name):
 
 # Insert a link to download the IPython notebook
 nbsphinx_prolog = r"""
-{% set docname = env.doc2path(env.docname, base='docs') %}
+{% set docname = env.doc2path(env.docname, base="docs") %}
 
 .. raw:: html
 
@@ -446,6 +447,10 @@ def __getattr__(cls, name):
 
 """
 
+nbsphinx_thumbnails = {
+    "visualization/plotly/basic-tutorials/GUI with Python Demo": "_static/visualization/plotly/basic-tutorials/GUIScreenshot.png"
+}
+
 import inspect
 
 

docs/index.rst

@@ -134,7 +134,6 @@ which fills in the version number.
    installation
    tutorials.rst
    scripts/scripts
-   visualization/visualization
    rst/files
 
 .. toctree::
@@ -143,6 +142,13 @@ which fills in the version number.
 
    toolbox/toolbox
 
+.. toctree::
+   :maxdepth: 4
+   :caption: Visualization
+   :glob:
+
+   visualization/*/index
+
 .. toctree::
    :maxdepth: 3
    :caption: Reference documentation

docs/visualization/ase/index.rst

@@ -0,0 +1,13 @@
+ASE
+---
+
+A sisl `Geometry` object may easily be converted to ASE objects and thus directly
+plotted.
+
+   import sisl
+   import ase.visualize.view as view
+
+   geom = sisl.geom.graphene()
+   view(geom.toASE())
+
+will open a new window showing the atoms.