.set_description(+)
Default PLANit Output Formatter method
Description
The .set_set_description(+) method provides you with the option to provide a description for the simulation run that is being included in the output via the XML meta-data file.
In future versions this description will be moved elsewhere
Signature
.set_description(description)
with
| Parameter | Type | Unit | Compulsory | Description |
|---|---|---|---|---|
description |
string |
None |
YES | Description to include in output |
Return type
None
Example 1
from planit import *
#prep
plan_it = Planit()
# configure to persist output in same directory
plan_it.project.output.set_description("My PLANit test run")
#
# <more configuration>
#
plan_it.project.run()
See also
N/A
Source code
Class PlanItOutputFormatterWrapper in projectwrappers.py