submit_ansys_cloud_job#

Desktop.submit_ansys_cloud_job(project_file, config_name, region, numnodes=1, numcores=32, wait_for_license=True, setting_file=None, job_name=None)[source]#

Submit a job to be solved on a cluster.

Parameters:

project_filestr: Full path to the project.
config_namestr: Name of the Ansys Cloud machine configuration selected.
regionstr: Name of Ansys Cloud location region. Available regions are: "westeurope", "eastus", "northcentralus", "southcentralus", "northeurope", "japaneast", "westus2", "centralindia".
numnodesint, optional: Number of nodes. The default is 1.
numcoresint, optional: Number of cores. The default is 32.
wait_for_licensebool, optional: Whether to wait for the license to be validated. The default is True.
setting_filestr, optional: Name of the file to use as a template. The default value is None.

Returns:

str, str: Job ID, job name.

References

>>> oDesktop.SubmitJob

Examples

>>> from pyaedt import Desktop

>>> d = Desktop(specified_version="2023.1", new_desktop_session=False)
>>> d.select_scheduler("Ansys Cloud")
>>> out = d.get_available_cloud_config()
>>> job_id, job_name = d.submit_ansys_cloud_job('via_gsg.aedt',
...                                             list(out.keys())[0],
...                                             region="westeurope",
...                                             job_name="MyJob"
...                                             )
>>> o1=d.get_ansyscloud_job_info(job_id=job_id)
>>> o2=d.get_ansyscloud_job_info(job_name=job_name)
>>> d.download_job_results(job_id=job_id,
...                        project_path='via_gsg.aedt',
...                        results_folder='via_gsg_results')
>>> d.release_desktop(False,False)