Tutorial guidelines¶

Steps in GUI tutorials¶

For steps in tutorials use the rst-class:: steps.

Example:

.. rst-class:: steps

    | Optionally some context here
    | **1.** The first step, e.g. click on **Edit → Builder**
    | **2.** The second step.

Result:

GUI icons¶

In the Tutorials, you can refer to some GUI buttons/icons by using the following substitutions (these substitutions are defined in global_conf.py, but that you have to initialize it in the conf.py of your specific project. See the Tutorials/conf.py).

Example:

.. rst-class:: steps

    | In **ADFInput**
    | **1.** Switch to the **BAND panel**: |ADFPanel| **→** |BANDPanel|
    | **2.** In the **search box** |Search| search for ``Diamond`` and select **Crystal → C**

Result:

In ADFInput

1. Switch to the BAND panel: →

2. In the search box search for Diamond and select Crystal → C

Conventions for step descriptions¶

How to phrase common tasks:

Switch to BAND by clicking on →

In the search box search for Diamond and select Crystal → C

In the panel bar, select Properties → Excitations (UV/Vis), CD

In the menu bar, select View → Reset View

Select Task → Geometry Optimization

In Total charge enter -1

Check/Uncheck the Unrestricted checkbox

Select the Carbon tool and click in the molecule drawing area

PLAMS Tutorials¶

The preferred way to create new tutorials for PLAMS is through jupyter notebooks. These are located in the $AMSHOME/scripting/scm/plams/examples directory.

From these notebooks, documentation pages can be generated by running a script generate_example.sh, located in the examples directory. This will create .rst files which can be included in the PLAMS Examples.

For full instructions on how to do this, see $AMSHOME/scripting/scm/plams/examples/README.md.