AppInterface.get_scen_attach
AppInterface.get_scen_attach |
Purpose
Retrieves an attachment from the Insight server either for a given scenario, placing it in the Python working directory where it can be read by the model.
Synopsis
get_scen_attach(self, filename: str, scenario_path: str = None) -> None
Arguments
|
filename
|
The filename of the attachment to be retrieved.
|
|
scenario_path
|
The path of a scenario. 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 If the scenario path is not specified, the attachment is retrieved for the current scenario.
|
Example
Example of copying a scenario attachment called
my_attach.dat to the working directory.
>>> insight.get_scen_attach('my_attach.dat')
... if insight.attach_status == AttachStatus.OK:
... with open('my_attach.dat') as f:
... pass # process the file
... else:
... print("Error retrieving attachment")
Getting an attachment for the current scenario.
>>> insight.get_scen_attach('my_attach.dat', '/myapp/DirA/myscenario')
... if insight.attach_status == AttachStatus.OK:
... with open('my_attach.dat') as f:
... pass # process the file
... else:
... print("Error retrieving attachment")
Getting an attachment for a scenario with path
/myapp/DirA/myscenario.
Further information
1. Check the attachment status code using
insight.attach_status to determine whether the attachment was successfully fetched.
2. Attempting to access attachments when the model is not being run through Xpress Insight will cause the model to abort with an error.
Related topics