description – Description of a simulation

class penelopetools.api.input.penelope.description.Description(title='Untitled')

Bases: penelopetools.api.input.penelope.option.Option

Creates a new Description.

Parameters:title (str) – title of the simulation

ATTR_TITLE = 'title'

KEYWORD = <penelopetools.api.input.penelope.util.Keyword object at 0x51b1690>

TAG_NAME = 'jobDescription'

classmethod from_inputfile(lines)

Creates a Description from lines of a IN file.

Parameters:lines – lines

classmethod from_xml(root)

Creates a Description from a XML element.

Parameters:element – XML element

title

Title of the simulation. A title cannot be empty or greater than the maximum title size. The initial title is set by the constructor.

to_html(header_level=1)

Returns a HTML representation of this option.

to_inputfile()

Returns the lines of this option to create a IN file.

to_xml()

Returns a XML representation of this option.