Installation

SLIDES is written in python3. The following packages are required:

  • nbsphinx==0.9.2

  • sphinx-rtd-theme==1.2.1

  • matplotlib==3.7.1

  • numpy==1.24.3

  • scipy==1.10.1

  • shapely==2.0.1

  • ase==3.22.1

From PIP

The easiest way to install SLIDES is via pip, see the project page here. To install type the following in your command line

pip install -i https://test.pypi.org/simple/ SLIDES

This will put the sources in your python path so that all the functions of this package will be accessible from any python script.

From source

You can get the source code by cloning our git repository. SLIDES is fully written in python, so no compiling is needed.

In the examples folder you will find the notebook underlying the examples shown in the documentation here. These notebooks are editable, so you can play around with different substrate, geometries and driver, ultimately tailoring the design to your system of interest!