Downloadable examples#

sigmaepsilon.mesh.downloads.delete_downloads() → bool[source]#

Delete all downloaded examples to free space or update the files. Returns True if the operation was succesful, or False if it wasn’t.

See also

download_file()

Examples

Delete all local downloads.

>>> from sigmaepsilon.core import delete_downloads
>>> delete_downloads()  
True

sigmaepsilon.mesh.downloads.download_badacsony(read: bool = False) → str | PolyData[source]#

Downloads and optionally reads the badacsony example as a vtk file.

Parameters:: read (bool, Optional) – If False, the path of the mesh file is returned instead of a PolyData object. Default is False.

Example

>>> from sigmaepsilon.mesh.downloads import download_badacsony
>>> mesh = download_badacsony(read=True)

sigmaepsilon.mesh.downloads.download_bunny(*, tetra: bool = False, read: bool = False) → str | PolyData[source]#

Downloads a tetrahedral mesh of a bunny in vtk format.

Parameters:

tetra (bool, Optional) – If True, the returned mesh is a tetrahedral one, otherwise it is a surface triangulation. Default is False.
read (bool, Optional) – If False, the path of the mesh file is returned instead of a PolyData object. Default is False.

Returns:

A path to a file on your filesystem.

Return type:

str

Example

>>> from sigmaepsilon.mesh.downloads import download_bunny
>>> download_bunny()
...

sigmaepsilon.mesh.downloads.download_bunny_coarse(tetra: bool = False, read: bool = False) → str | PolyData[source]#

Downloads and optionally reads the bunny example as a vtk file.

Parameters:

tetra (bool, Optional) – If True, the returned mesh is a tetrahedral one, otherwise it is a surface triangulation. Default is False.
read (bool, Optional) – If False, the path of the mesh file is returned instead of a PolyData object. Default is False.

Example

>>> from sigmaepsilon.mesh.downloads import download_bunny_coarse
>>> mesh = download_bunny_coarse(tetra=True, read=True)

sigmaepsilon.mesh.downloads.download_gt40(read: bool = False) → str | PolyData[source]#

Downloads and optionally reads the Gt40 example as a vtk file.

Parameters:: read (bool, Optional) – If False, the path of the mesh file is returned instead of a PolyData object. Default is False.

Example

>>> from sigmaepsilon.mesh.downloads import download_gt40
>>> mesh = download_gt40(read=True)

sigmaepsilon.mesh.downloads.download_stand(*, read: bool = False) → str | PolyData[source]#

Downloads a tetrahedral mesh of a stand in vtk format.

Parameters:: read (bool, Optional) – If False, the path of the mesh file is returned instead of a PolyData object. Default is False.
Returns:: A path to a file on your filesystem.
Return type:: str

Example

>>> from sigmaepsilon.mesh.downloads import download_stand
>>> download_stand()
...