AppInterface.scenario_path

Purpose

Property for the path of the Xpress Insight scenario.

Synopsis

scenario_path: str

Return value

The name of the Xpress Insight scenario.

Example

Demonstration of setting the scenario path (test mode only).

>>> insight.scenario_path = '/myapp/DirA/myscenario'

Demonstration of getting the scenario path.

>>> print('scenario path = ', insight.scenario_path)
scenario path = /myapp/DirA/myscenario

Further information

1. A scenario path is the full path to a scenario name starting from the repository root and including the app name. E.g. /myapp/DirA/myscenario.

2. The scenario_path property can only be set in test mode.

3. In test mode can be used to mock the Insight scenario name. By default, insight.scenario_path will return an empty string in test mode.

4. Modifying this property when insight.test_mode is False will cause the model to abort with a runtime error.