AppInterface.put_scen_attach
AppInterface.put_scen_attach |
Purpose
Uploads a scenario attachment to the Insight server, reading it from the Python working directory.
Synopsis
put_scen_attach(self, filename: str, overwrite: bool = True) -> None
Arguments
|
filename
|
The filename of the attachment to be uploaded
|
|
overwrite
|
If
True, will overwrite attachment if it already exists. If
False and attachment already exists, will fail with insight.attach_status returning AttachStatus.ALREADY_EXISTS. Defaults to
True if not given.
|
Example
Example of taking a file
my_attach.dat in the working directory, and saving it as a new scenario attachment called
my_attach.dat.
>>> insight.put_scen_attach('my_attach.dat', False)
... if insight.attach_status == AttachStatus.OK:
... print("Attachment added ok")
... elif insight.attach_status == AttachStatus.ALREADY_EXISTS:
... print("Attachment already exists")
... else:
... print("Error adding attachment:", insight.attach_status)
Further information
1. Check the attachment status code using
insight.attach_status to determine whether the attachment was successfully added.
2. The new attachment will not be available on the Insight server until the scenario completes.
3. 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