Downloads#

Download example datasets from ansys/example-data

ansys.dpf.core.examples.downloads.delete_downloads(verbose=True)#

Delete all downloaded examples to free space or update the files

ansys.dpf.core.examples.downloads.download_transient_result(should_upload: bool = True, server=None, return_local_path=False)#

Download an example transient result file and return the download path available server side. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_transient_result()
>>> path
'C:/Users/user/AppData/local/temp/transient.rst'
ansys.dpf.core.examples.downloads.download_all_kinds_of_complexity(should_upload: bool = True, server=None, return_local_path=False)#

Download an example static result and return the download path available server side. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_all_kinds_of_complexity()
>>> path
'C:/Users/user/AppData/local/temp/allKindOfComplexity.rst'
ansys.dpf.core.examples.downloads.download_all_kinds_of_complexity_modal(should_upload: bool = True, server=None, return_local_path=False)#

Download an example result file from a static modal analysis and return the download path available server side. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_all_kinds_of_complexity_modal()
>>> path
'C:/Users/user/AppData/local/temp/modal_allKindOfComplexity.rst'
ansys.dpf.core.examples.downloads.download_pontoon(should_upload: bool = True, server=None, return_local_path=False)#

Download an example result file from a static modal analsys and return the download path available server side. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_pontoon()
>>> path
'C:/Users/user/AppData/local/temp/pontoon.rst'
ansys.dpf.core.examples.downloads.download_multi_harmonic_result(should_upload: bool = True, server=None, return_local_path=False)#

Download an example multi-harmonic result file and return the download path available server side. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_multi_harmonic_result()
>>> path
'C:/Users/user/AppData/local/temp/file_harmonic_5rpms.rst'
ansys.dpf.core.examples.downloads.download_multi_stage_cyclic_result(should_upload: bool = True, server=None, return_local_path=False)#

Download an example multi-stage result file and return the download path available server side. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_multi_stage_cyclic_result()
>>> path
'C:/Users/user/AppData/local/temp/multistage.rst'
ansys.dpf.core.examples.downloads.download_sub_file(should_upload: bool = True, server=None, return_local_path=False)#

Download an example .sub result file containing matrices and return the download path available server side. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_sub_file()
>>> path
'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\sub\cp56.sub'
ansys.dpf.core.examples.downloads.download_msup_files_to_dict(should_upload: bool = True, server=None, return_local_path=False)#

Download all the files necessary for a msup expansion and return the download paths available server side into a dictionary extension->path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

dict[str – Path to the example files.

Return type:

str]

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> paths = examples.download_msup_files_to_dict()
>>> paths
{'rfrq': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\msup\file.rfrq',
 'mode': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\msup\file.mode',
 'rst': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\msup\file.rst'} # noqa: E501
ansys.dpf.core.examples.downloads.download_distributed_files(should_upload: bool = True, server=None, return_local_path=False)#

Download distributed rst files and return the download paths into a dictionary domain id->path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

dict[int – Path to the example files.

Return type:

str]

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> paths = examples.download_distributed_files()
>>> paths
{0: 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\distributed\file0.rst',
 1: 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\distributed\file1.rst'} # noqa: E501
ansys.dpf.core.examples.downloads.download_fluent_multi_species(should_upload: bool = True, server=None, return_local_path=False)#

Download the cas and dat file of a fluent analysis with multiple species and return the download paths into a dictionary extension->path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

dict[str – Path to the example files.

Return type:

str]

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> paths = examples.download_fluent_multi_species()
>>> paths
{'cas': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-multi_species\FFF.cas.h5',
 'dat': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-multi_species\FFF.dat.h5'} # noqa: E501
ansys.dpf.core.examples.downloads.download_fluent_multi_phase(should_upload: bool = True, server=None, return_local_path=False)#

Download the cas and dat file of a fluent analysis with multiple phases and return the download paths into a dictionary extension->path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

dict[str – Path to the example files.

Return type:

str]

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> paths = examples.download_fluent_multi_phase()
>>> paths
{'cas': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-multi_phase\fluentMultiphase.cas.h5',
 'dat': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-multi_phase\fluentMultiphase.dat.h5'} # noqa: E501
ansys.dpf.core.examples.downloads.download_extrapolation_3d_result(should_upload: bool = True, server=None, return_local_path=False)#

Download example static results of reference and integrated points for extrapolation of 3d-element and return the dictionary of 2 download paths. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

containing path to the example file of ref and path to the example file of integrated points.

Return type:

dict

Examples

Download 2 example result files and return the dictionary containing 2 files

>>> from ansys.dpf.core import examples
>>> path_dict = examples.download_extrapolation_ref_result()
>>> path_dict
{
    'file_ref': 'C:/Users/user/AppData/local/temp/file_ref.rst',
    'file_integrated': 'C:/Users/user/AppData/local/temp/file.rst'
}
ansys.dpf.core.examples.downloads.download_extrapolation_2d_result(should_upload: bool = True, server=None, return_local_path=False)#

Download example static results of reference and integrated points for extrapolation of 2d-element and return the dictionary of 2 download paths. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Contains path to the example file of ref and path to the example file of integrated points.

Return type:

dict

Examples

Download 2 example result files and return the dictionary containing 2 files

>>> from ansys.dpf.core import examples
>>> path_dict = examples.download_extrapolation_ref_result()
>>> path_dict
{
    'file_ref': 'C:/Users/user/AppData/local/temp/extrapolate_2d_ref.rst',
    'file_integrated': 'C:/Users/user/AppData/local/temp/extrapolate_2d.rst'
}
ansys.dpf.core.examples.downloads.download_hemisphere(should_upload: bool = True, server=None, return_local_path=False)#

Download an example result file from a static analysis and return the download path available server side. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_hemisphere()
>>> path
'C:/Users/user/AppData/local/temp/hemisphere.rst'
ansys.dpf.core.examples.downloads.download_example_asme_result(should_upload: bool = True, server=None, return_local_path=False)#

Download an example result file from a static analysis and return the download path available server side. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file >>> from ansys.dpf.core import examples >>> path = examples.download_example_asme_result() >>> path ‘C:/Users/user/AppData/local/temp/asme_example.rst’

ansys.dpf.core.examples.downloads.download_crankshaft(should_upload: bool = True, server=None, return_local_path=False)#

Download the result file of an example of a crankshaft under load and return the download path available server side. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_crankshaft()
>>> path
'C:/Users/user/AppData/local/temp/crankshaft.rst'
ansys.dpf.core.examples.downloads.download_piston_rod(should_upload: bool = True, server=None, return_local_path=False)#

Download the result file of an example of a piston rod under load and return the download path available server side. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_piston_rod()
>>> path
'C:/Users/user/AppData/local/temp/piston_rod.rst'
ansys.dpf.core.examples.downloads.download_d3plot_beam(should_upload: bool = True, server=None, return_local_path=False)#

Download the result file of an example of a d3plot file with beam elements and return the download paths available on the server side. If the server is remote (or doesn’t share the memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded to the server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the files.

>>> from ansys.dpf.core import examples
>>> paths = examples.download_d3plot_beam()
>>> paths
['C:/Users/user/AppData/local/temp/d3plot',
 'C:/Users/user/AppData/local/temp/d3plot01',
 'C:/Users/user/AppData/local/temp/d3plot02'
 'C:/Users/user/AppData/local/temp/file.actunits']
ansys.dpf.core.examples.downloads.download_binout_matsum(should_upload: bool = True, server=None, return_local_path=False)#

Download the result file of an example of a binout file with matsum branch and return the download path available on the server side. If the server is remote (or doesn’t share the memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded to the server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file.

>>> from ansys.dpf.core import examples
>>> path = examples.download_binout_matsum()
>>> path
'C:/Users/user/AppData/local/temp/binout_matsum'
ansys.dpf.core.examples.downloads.download_binout_glstat(should_upload: bool = True, server=None, return_local_path=False)#

Download the result file of an example of a binout file with glstat branch and return the download path available on the server side. If the server is remote (or doesn’t share the memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded to the server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file.

>>> from ansys.dpf.core import examples
>>> path = examples.download_binout_glstat()
>>> path
'C:/Users/user/AppData/local/temp/binout_glstat'
ansys.dpf.core.examples.downloads.download_cycles_to_failure(should_upload: bool = True, server=None, return_local_path=False)#

Download an example result file from a cyclic analysis and return the download path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_cycles_to_failure()
>>> path
'C:/Users/user/AppData/local/temp/cycles_to_failure.rst'
ansys.dpf.core.examples.downloads.download_modal_frame(should_upload: bool = True, server=None, return_local_path=False)#

Download an example result file from a modal analysis on a frame and return the download path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_modal_frame()
ansys.dpf.core.examples.downloads.download_harmonic_clamped_pipe(should_upload: bool = True, server=None, return_local_path=False)#

Download an example result file from a harmonic analysis on a clamped pipe and return the download path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_modal_frame()
ansys.dpf.core.examples.downloads.download_modal_cyclic(should_upload: bool = True, server=None, return_local_path=False)#

Download an example result file from a cyclic modal analysis and return the download path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_modal_cyclic()
ansys.dpf.core.examples.downloads.download_fluent_axial_comp(should_upload: bool = True, server=None, return_local_path=False)#

Download the flprj, cas and dat files of a fluent analysis of an axial compressor sector and return the download paths into a dictionary extension->path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

dict[str – Path to the example files.

Return type:

str]

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> paths = examples.download_fluent_axial_comp()
>>> paths
{'flprj': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-axial_comp\axial_comp_reduced.flprj',
 'cas': [
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-axial_comp\axial_comp-1-01438.cas.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-axial_comp\axial_comp-1-01439.cas.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-axial_comp\axial_comp-1-01440.cas.h5',
 ],
 'dat': [
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-axial_comp\axial_comp-1-01438.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-axial_comp\axial_comp-1-01439.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-axial_comp\axial_comp-1-01440.dat.h5',
 ]} # noqa: E501
ansys.dpf.core.examples.downloads.download_fluent_mixing_elbow_steady_state(should_upload: bool = True, server=None, return_local_path=False)#

Download the flprj, cas and dat files of a steady-state fluent analysis of a mixing elbow and return the download paths into a dictionary extension->path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

dict[str – Path to the example files.

Return type:

str]

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> paths = examples.download_fluent_mixing_elbow_steady_state()
>>> paths
{'flprj': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow.flprj',
 'cas': [
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow-2.cas.h5',
 ],
 'dat': [
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow-2-00005.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow-2-00010.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow-2-00015.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow-2-00020.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow-2-00025.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow-2-00030.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow-2-00035.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow-2-00040.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow-2-00045.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_steady-state\elbow-2-00050.dat.h5',
 ]} # noqa: E501
ansys.dpf.core.examples.downloads.download_fluent_mixing_elbow_transient(should_upload: bool = True, server=None, return_local_path=False)#

Download the flprj, cas and dat files of a transient fluent analysis of a mixing elbow and return the download paths into a dictionary extension->path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

dict[str – Path to the example files.

Return type:

str]

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> paths = examples.download_fluent_mixing_elbow_transient()
>>> paths
{'flprj': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_transient\elbow.flprj',
 'cas': [
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_transient\elbow-2.cas.h5',
 ],
 'dat': [
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_transient\elbow-2-00001.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_transient\elbow-2-00002.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_transient\elbow-2-00003.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_transient\elbow-2-00004.dat.h5',
   'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\fluent-mixing_elbow_transient\elbow-2-00005.dat.h5',
 ]} # noqa: E501
ansys.dpf.core.examples.downloads.download_cfx_heating_coil(should_upload: bool = True, server=None, return_local_path=False)#

Download the flprj, cas and dat files of a CFX analysis of a heating coil and return the download paths into a dictionary extension->path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

dict[str – Path to the example files.

Return type:

str]

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> paths = examples.download_cfx_heating_coil()
>>> paths
{'cas': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\cfx-heating_coil\def.cas.cff',
 'dat': 'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\cfx-heating_coil\def.dat.cff'} # noqa: E501
ansys.dpf.core.examples.downloads.download_cfx_mixing_elbow(should_upload: bool = True, server=None, return_local_path=False)#

Download the res file of a CFX analysis of a mixing elbow and return the download path. If the server is remote (or doesn’t share memory), the file is uploaded or made available on the server side.

Examples files are downloaded to a persistent cache to avoid re-downloading the same file twice.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

Download an example result file and return the path of the file

>>> from ansys.dpf.core import examples
>>> path = examples.download_cfx_mixing_elbow()
>>> path
'C:\Users\user\AppData\Local\ansys-dpf-core\ansys-dpf-core\examples\cfx-mixing_elbow\InjectMixer.res' # noqa: E501
ansys.dpf.core.examples.downloads.find_simple_bar(should_upload: bool = True, server=None, return_local_path=False)#

Make the result file available server side, if the server is remote the file is uploaded server side. Returns the path on the file.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

>>> from ansys.dpf.core import examples
>>> path = examples.find_simple_bar()
>>> path
'C:/Users/user/AppData/local/temp/ASimpleBar.rst'
ansys.dpf.core.examples.downloads.find_static_rst(should_upload: bool = True, server=None, return_local_path=False)#

Make the result file available server side, if the server is remote the file is uploaded server side. Returns the path on the file.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

>>> from ansys.dpf.core import examples
>>> path = examples.find_static_rst()
>>> path
'C:/Users/user/AppData/local/temp/static.rst'
ansys.dpf.core.examples.downloads.find_complex_rst(should_upload: bool = True, server=None, return_local_path=False)#

Make the result file available server side, if the server is remote the file is uploaded server side. Returns the path on the file.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

>>> from ansys.dpf.core import examples
>>> path = examples.find_complex_rst()
>>> path
'C:/Users/user/AppData/local/temp/complex.rst'
ansys.dpf.core.examples.downloads.find_multishells_rst(should_upload: bool = True, server=None, return_local_path=False)#

Make the result file available server side, if the server is remote the file is uploaded server side. Returns the path on the file.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

>>> from ansys.dpf.core import examples
>>> path = examples.find_multishells_rst()
>>> path
'C:/Users/user/AppData/local/temp/model_with_ns.rst'
ansys.dpf.core.examples.downloads.find_electric_therm(should_upload: bool = True, server=None, return_local_path=False)#

Make the result file available server side, if the server is remote the file is uploaded server side. Returns the path on the file.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

>>> from ansys.dpf.core import examples
>>> path = examples.find_electric_therm()
>>> path
'C:/Users/user/AppData/local/temp/rth_electric.rth'
ansys.dpf.core.examples.downloads.find_steady_therm(should_upload: bool = True, server=None, return_local_path=False)#

Make the result file available server side, if the server is remote the file is uploaded server side. Returns the path on the file.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

>>> from ansys.dpf.core import examples
>>> path = examples.find_steady_therm()
>>> path
'C:/Users/user/AppData/local/temp/rth_steady.rth'
ansys.dpf.core.examples.downloads.find_transient_therm(should_upload: bool = True, server=None, return_local_path=False)#

Make the result file available server side, if the server is remote the file is uploaded server side. Returns the path on the file.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

>>> from ansys.dpf.core import examples
>>> path = examples.find_transient_therm()
>>> path
'C:/Users/user/AppData/local/temp/rth_transient.rth'
ansys.dpf.core.examples.downloads.find_msup_transient(should_upload: bool = True, server=None, return_local_path=False)#

Make the result file available server side, if the server is remote the file is uploaded server side. Returns the path on the file.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

>>> from ansys.dpf.core import examples
>>> path = examples.find_msup_transient()
>>> path
'C:/Users/user/AppData/local/temp/msup_transient_plate1.rst'
ansys.dpf.core.examples.downloads.find_simple_cyclic(should_upload: bool = True, server=None, return_local_path=False)#

Make the result file available server side, if the server is remote the file is uploaded server side. Returns the path on the file.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

>>> from ansys.dpf.core import examples
>>> path = examples.find_simple_cyclic()
>>> path
'C:/Users/user/AppData/local/temp/file_cyclic.rst'
ansys.dpf.core.examples.downloads.find_distributed_msup_folder(should_upload: bool = True, server=None, return_local_path=False)#

Make the result file available server side, if the server is remote the file is uploaded server side. Returns the path on the file.

Parameters:

  • should_upload (bool, optional (default True)) – Whether the file should be uploaded server side when the server is remote.

  • server (server.DPFServer, optional) – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

  • return_local_path (bool, optional) – If True, the local path is returned as is, without uploading, nor searching for mounted volumes.

Returns:

Path to the example file.

Return type:

str

Examples

>>> from ansys.dpf.core import examples
>>> path = examples.find_distributed_msup_folder()
>>> path
'C:/Users/user/AppData/local/temp/msup_distributed'