Example

class ase2sprkkr.gui.examples.Example(path)[source]

Class hierarchy

Inheritance diagram of ase2sprkkr.gui.examples.Example

Constructor

Parameters:

path (Path)

__init__(path)[source]
Parameters:

path (Path)

static by_number(example)[source]

Directory for the given example

Parameters:

example (int)

copy(dest_dir)[source]

Copy contents of ase2sprkkr.examples.A{n:02d}_* directory into dest_dir and return the path to the .py script inside that example directory (excluding __init__.py).

Parameters:
  • n – Example number (integer)

  • dest_dir (str) – Destination directory where files will be copied

Returns:

Path to the .py example script

property name
property main_script

Find Python script inside example directory (excluding __init__.py). Now we suspose, that the first such one is the main.

property docstring
property short_docstring
source()[source]
body_of_main()[source]