solidipes.viewers package

Submodules

Module contents

class solidipes.viewers.Binary(data=None)[source]

Bases: Viewer

Viewer for (unknown) binary

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Append text to the viewer

show()[source]: Show the viewer

class solidipes.viewers.Code(data=None, display_lint=True)[source]

Bases: Text

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Append code to the viewer

show()[source]: Show the viewer

class solidipes.viewers.HDF5(data=None)[source]

Bases: Viewer

Viewer for HDf5

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Replace the viewer’s hdf5

datasets: Image to display

show()[source]: Show the viewer

class solidipes.viewers.Image(data=None)[source]

Bases: Viewer

Viewer for images

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Replace the viewer’s image

image: Image to display

show()[source]: Show the viewer

svg_format(svg)[source]

class solidipes.viewers.ImageSource(data=None)[source]

Bases: Viewer

Viewer for images produced by sources

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Replace the viewer’s image

image: Image to display

show()[source]: Show the viewer

class solidipes.viewers.MarkdownViewer(data=None)[source]

Bases: Text

_abc_impl = <_abc._abc_data object>

show()[source]: Show the viewer

class solidipes.viewers.MatlabData(data=None)[source]

Bases: Viewer

Viewer for Matlab Data .mat file

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Append text to the viewer

arrays: Text to display

show()[source]: Show the viewer

class solidipes.viewers.Notebook(data=None)[source]

Bases: Viewer

Viewer for notebooks

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Append text to the viewer

notebook: Text to display

show()[source]: Show the viewer

class solidipes.viewers.PDF(data=None, height=1000)[source]

Bases: Viewer

Viewer for pdfs

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Replace the viewer’s image

pdf: Image to display

show()[source]: Show the viewer

class solidipes.viewers.PyvistaPlotter(data_container=None, add_kwargs={}, show_kwargs={}, **kwargs)[source]

Bases: Viewer

Viewer for pyvista meshes

Parameters:: **kwargs – keyword arguments passed to the pyvista.Plotter constructor

_abc_impl = <_abc._abc_data object>

_update_path_list(data_container)[source]

add(data_container, **kwargs)[source]

Add mesh to the viewer

Parameters:: **kwargs – keyword arguments passed to the pyvista.Plotter.add_mesh method

add_mesh(data_container: DataContainer, **kwargs)[source]

Add mesh to the viewer

Parameters:: **kwargs – keyword arguments passed to the pyvista.Plotter.add_mesh method

add_points(data_container, **kwargs)[source]

Add mesh as points to the viewer

Parameters:: **kwargs – keyword arguments passed to the pyvista.Plotter.add_points method

plotter: Pyvista plotter

save(path, **kwargs)[source]

Save the view to a file

Parameters:

path – path to the file
**kwargs – keyword arguments passed to the pyvista.Plotter.screenshot method

show(auto_close=False, **kwargs)[source]

Show the viewer

Parameters:

auto_close – whether to close the viewer after showing it
**kwargs – keyword arguments passed to the pyvista.Plotter.show method

shown: keeps track of whether the plotter has already been shown

class solidipes.viewers.SymLink(data=None)[source]

Bases: Viewer

Viewer for symlinks

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Replace the viewer’s image

show()[source]: Show the viewer

video: Image to display

class solidipes.viewers.Table(data_container=None)[source]

Bases: Viewer

Viewer for tables

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Replace the viewer’s table

data_container: Table to display

show(*args, **kwargs): Show the viewer

show_plot()[source]

class solidipes.viewers.Text(data=None)[source]

Bases: Viewer

Viewer for formatted text

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Append text to the viewer

show()[source]: Show the viewer

text: Text to display

class solidipes.viewers.Video(data=None)[source]

Bases: Viewer

Viewer for videos

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Replace the viewer’s image

show()[source]: Show the viewer

video: Image to display

class solidipes.viewers.Viewer(data_container=None, add_kwargs={}, show_kwargs={}, **kwargs)[source]

Bases: ABC

Abstract class for viewers

If istanciated with data, it will directly display it.

Parameters:

data – data to display
add_kwargs – kwargs to pass to the add method. Note: cannot be passed as a positional argument because of get_data_from_container decorator.
show_kwargs – kwargs to pass to the show method
**kwargs – kwargs to pass to the init method

_abc_impl = <_abc._abc_data object>

abstract add(data, **kwargs)[source]: Add data to the viewer

check_data_compatibility(data)[source]: Check if data is compatible with the viewer

compatible_data_types: List of data types that are compatible with the viewer

save(path, **kwargs)[source]: Save the view to a file

abstract show(**kwargs)[source]: Show the viewer

class solidipes.viewers.XDMF(data=None)[source]

Bases: XML

Viewer for xml text files

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Append text to the viewer

show()[source]: Show the viewer

class solidipes.viewers.XML(data=None)[source]

Bases: Viewer

Viewer for xml text files

_abc_impl = <_abc._abc_data object>

add(data_container)[source]: Append text to the viewer

show()[source]: Show the viewer