download

Renderable.download(dirname: str) → List[str]

Download the content files for the renderable.

A renderable saves files (such as images, mpegs, and geometry) in the EnSight instance. Normally, these files are accessed via the webpage specified in the URL property. This method allows for those files to be downloaded to a local directory so that they can be used for other purposes.

Note

Any previously existing files with the same name are overwritten.

Parameters:

dirnamestr

Name of the existing directory to save the files to.

Returns:

list

List of names for the downloaded files.

Examples

Download the PNG file generated by the image renderable.

>>> img = session.show('image", width=640, height=480, aa=4)
>>> names = img.download("/tmp")
>>> png_pathname = os.path.join("/tmp", names[0])