Evaluate for Free

burstresultsdownload – Script command

FDTD

Downloads simulation result for a given Ansys Cloud Burst Compute™ job, with optional file filtering.

When downloading GPU simulations, results are automatically placed in the correct folder. For sweeps, this script command downloads each simulation but does not reconstruct the parent file. If the download is interrupted or if no files are downloaded, an error message is shown.

Note: The console log file console.log cannot be downloaded via this script command. You can download it via the Ansys Engineering Portal.

Syntax  Description 
out=burstresultsdownload (“job_id”, “sim_id”, download_options);

Downloads a given Ansys Cloud Burst Compute™ job with the following parameters:

  • job_id: The ID of the job as a string, which you can obtain using script commands such as burstrecentids, or through the Ansys Engineering Portal.
  • sim_id: Optional, the ID of the simulation as a string, this only applies if you wish to download a single result from a parameter sweep. If left blank, the script downloads all simulations from the job.
  • download_options: Optional, struct that specifies options including destination directory and file filtering. The detail of the struct is discussed below. If left blank, the script downloads all files into the current working directory.

This function returns the names of downloaded files in a cell array.

The attributes of the download_options struct is as follows.

Attribute Description
dest_dir A string to indicate the destination folder for the download. If left blank, the default location is the current working directory. The destination must already exist.
file_filter A string to filter the file(s) for download. You can use * either in the beginning or the end to indicate wildcards.

Example

# Get most recent id
recent_jobs = burstrecentids;
dl_id=recent_jobs{1};

# Construct filter and destination

dl_dest = "C:\Downloads";
dl_filter="*.log"; # Download only logs

dl_options = {"dest_dir":dl_dest, "file_filter":dl_filter};

dl_out = burstresultsdownload(dl_id,dl_options);

See Also

burstjobstatus, burstresultsquery, burstrecentids, Ansys Cloud Burst Compute™ for Lumerical.

Associated files

Related articles