Visualization based on Plotly

class opstool.vis.OpsVisPlotly(point_size=2, line_width=4, colors_dict=None, theme='plotly', color_map='jet', on_notebook=False, results_dir='opstool_output')

A class to visualize OpenSeesPy model based on plotly.

Parameters

point_size: float

The render size of node.

line_width: float

The width of line element;

colors_dict: dict,

The dict for ele color, default color you can see by the class attribute default_colors.

theme: str, default=plotly

Plot theme, optional “plotly”, “plotly_white”, “plotly_dark”, “ggplot2”, “seaborn”, “simple_white”, “none”.

color_map: str, default=”jet”

color map to display the cloud plot. Optional, [‘aggrnyl’, ‘agsunset’, ‘algae’, ‘amp’, ‘armyrose’, ‘balance’, ‘blackbody’, ‘bluered’, ‘blues’, ‘blugrn’, ‘bluyl’, ‘brbg’, ‘brwnyl’, ‘bugn’, ‘bupu’, ‘burg’, ‘burgyl’, ‘cividis’, ‘curl’, ‘darkmint’, ‘deep’, ‘delta’, ‘dense’, ‘earth’, ‘edge’, ‘electric’, ‘emrld’, ‘fall’, ‘geyser’, ‘gnbu’, ‘gray’, ‘greens’, ‘greys’, ‘haline’, ‘hot’, ‘hsv’, ‘ice’, ‘icefire’, ‘inferno’, ‘jet’, ‘magenta’, ‘magma’, ‘matter’, ‘mint’, ‘mrybm’, ‘mygbm’, ‘oranges’, ‘orrd’, ‘oryel’, ‘oxy’, ‘peach’, ‘phase’, ‘picnic’, ‘pinkyl’, ‘piyg’, ‘plasma’, ‘plotly3’, ‘portland’, ‘prgn’, ‘pubu’, ‘pubugn’, ‘puor’, ‘purd’, ‘purp’, ‘purples’, ‘purpor’, ‘rainbow’, ‘rdbu’, ‘rdgy’, ‘rdpu’, ‘rdylbu’, ‘rdylgn’, ‘redor’, ‘reds’, ‘solar’, ‘spectral’, ‘speed’, ‘sunset’, ‘sunsetdark’, ‘teal’, ‘tealgrn’, ‘tealrose’, ‘tempo’, ‘temps’, ‘thermal’, ‘tropic’, ‘turbid’, ‘turbo’, ‘twilight’, ‘viridis’, ‘ylgn’, ‘ylgnbu’, ‘ylorbr’, ‘ylorrd’].

on_notebook: bool, default=False

Whether work in a jupyter notebook.

Note

This argument is deprecated since v0.8.0, you can call the show method to display figure.

results_dir: str, default=”opstool_output”

The dir that results saved.

Returns

None

deform_anim(input_file='NodeRespStepData-1.hdf5', response='disp', alpha=1.0, show_outline=False, opacity=1, framerate=24, show_face_line=True, save_html=None, model_update=False)

Deformation animation of the model.

Parameters

input_file: str, default = “NodeRespStepData-1.hdf5”,

The filename that node responses data saved by opstool.vis.GetFEMdata.get_node_resp_step() or opstool.vis.GetFEMdata.save_resp_all().

Warning

Be careful not to include any path, only filename, the file will be loaded from the directory results_dir.

response: str, default=’disp’

Response type. Optional, “disp”, “vel”, “accel”.

alpha: float, default=1.0

Model scaling factor, scale further on existing display.

show_outline: bool, default=False

Whether to display the axes.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

framerate: int, default=24

The number of frames per second.

opacity: float, default=1.0

Plane and solid element transparency.

save_html: str, default=None

The html file name to output. If False, the html file will not be generated.

Note

This argument is deprecated since v0.8.0, you can call the write_html method to write an html file.

model_update: bool, default False

whether to update the model domain data at each analysis step, this will be useful if model data has changed. For example, some elements and nodes were removed. This parameter must same as that in opstool.vis.GetFEMdata.get_node_resp_step().

Returns

Plotly Figure object

You can call the write_html method to output an html file, and the show method will display it.

deform_vis(input_file='NodeRespStepData-1.hdf5', slider=False, response='disp', alpha=1.0, show_outline=False, show_origin=False, show_face_line=True, opacity=1, save_html=None, model_update=False)

Visualize the deformation of the model at a certain analysis step.

Parameters

input_file: str, default = “NodeRespStepData-1.hdf5”,

The filename that node responses data saved by opstool.vis.GetFEMdata.get_node_resp_step() or opstool.vis.GetFEMdata.save_resp_all().

Warning

Be careful not to include any path, only filename, the file will be loaded from the directory results_dir.

slider: bool, default=False

If True, responses in all steps will display by slider style. If False, the step that max response will display.

response: str, default=’disp’

Response type. Optional, “disp”, “vel”, “accel”.

alpha: float, default=1.0

Model scaling factor, scale further on existing display.

show_outline: bool, default=False

Whether to display the axes.

show_origin: bool, default=False

Whether to show undeformed shape.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

opacity: float, default=1.0

Plane and solid element transparency.

save_html: str, default=None

The html file name to output. If False, the html file will not be generated.

Note

This argument is deprecated since v0.8.0, you can call the write_html method to write an html file.

model_update: bool, default False

whether to update the model domain data at each analysis step, this will be useful if model data has changed. For example, some elements and nodes were removed. This parameter must same as that in opstool.vis.GetFEMdata.get_node_resp_step().

Returns

Plotly Figure object

You can call the write_html method to output an html file, and the show method will display it.

eigen_anim(mode_tag=1, input_file='EigenData.hdf5', n_cycle=5, alpha=1.0, show_outline=False, label_size=15, opacity=1, framerate=3, show_face_line=True, save_html=None)

Animation of Modal Analysis.

Parameters

mode_tag: int

The mode tag.

input_file: str, default = ‘EigenData.hdf5’,

The filename that eigen data saved by opstool.vis.GetFEMdata.get_eigen_data().

Warning

Be careful not to include any path, only filename, the file will be loaded from the directory results_dir.

n_cycle: int, default = 5,

The number of cycles in the positive and negative directions of the modal deformation.

alpha: float, default=1.0

Model scaling factor, scale further on existing display.

show_outline: bool, default=False

Whether to display the axes.

opacity: float, default=1.0

Plane and solid element transparency.

framerate: int

The number of frames per second.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

save_html: str, default=None

The html file name to output. If False, the html file will not be generated.

Note

This argument is deprecated since v0.8.0, you can call the write_html method to write an html file.

Returns

Plotly Figure object

You can call the write_html method to output an html file, and the show method will display it.

eigen_vis(mode_tags, input_file='EigenData.hdf5', subplots=False, alpha=1.0, show_outline=False, show_origin=False, label_size=15, opacity=1.0, show_face_line=True, save_html=None)

Eigenvalue Analysis Visualization.

Parameters

mode_tags: list[int], or tuple[int]

Mode tags to be shown, if list or tuple [mode1, mode2], display the multiple modes from mode1 to mode2.

input_file: str, default = ‘EigenData.hdf5’,

The filename that eigen data saved by opstool.vis.GetFEMdata.get_eigen_data().

Warning

Be careful not to include any path, only filename, the file will be loaded from the directory results_dir.

subplots: bool, default=False

If True, subplots in a figure. If False, plot in a slide style.

alpha: float, default=1.0

Model scaling factor, scale further on existing display.

show_outline: bool, default=True

Whether to display the axes.

show_origin: bool, default=False

Whether to show undeformed shape.

label_size: float, default=15

The fontsize of text labels.

opacity: float, default=1.0

Plane and solid element transparency.

show_face_line: bool, default=True

If True, the edges of plate and solid elements will be displayed.

save_html: str, default=None

The html file name to output. If False, the html file will not be generated.

Note

This argument is deprecated since v0.8.0, you can call the write_html method to write an html file.

Returns

Plotly Figure object

You can call the write_html method to output an html file, and the show method will display it.

frame_resp_vis(input_file='BeamRespStepData-1.hdf5', ele_tags=None, slider=False, response='Mz', show_values=True, alpha=1.0, opacity=1, save_html=None)

Display the force response of frame elements.

Parameters

input_file: str, default = “BeamRespStepData-1.hdf5”,

The filename that beam frame elements responses data saved by opstool.vis.GetFEMdata.get_frame_resp_step() or opstool.vis.GetFEMdata.save_resp_all().

Warning

Be careful not to include any path, only filename, the file will be loaded from the directory results_dir.

ele_tags: int or list[int], default=None

Element tags to display, if None, all frame elements will display.

slider: bool, default=False

If True, responses in all steps will display by slider style. If False, the step that max response will display.

response: str, default=’Mz’

Response type. Optional, “Fx”, “Fy”, “Fz”, “My”, “Mz”, “Mx”.

show_values: bool, default=True

If True, will show the response values.

alpha: float, default=1.0

Model scaling factor, scale further on existing display.

opacity: float, default=1.0

Plane and solid element transparency.

save_html: str, default=None

The html file name to output. If False, the html file will not be generated.

Note

This argument is deprecated since v0.8.0, you can call the write_html method to write an html file.

Returns

Plotly Figure object

You can call the write_html method to output an html file, and the show method will display it.

model_vis(input_file='ModelData.hdf5', show_node_label=False, show_ele_label=False, show_local_crd=False, show_local_crd_shell=False, local_crd_alpha=1.0, show_fix_node=True, fix_node_alpha=1.0, show_load=False, load_alpha=1.0, show_constrain_dof=False, show_beam_sec=False, beam_sec_paras=None, label_size=8, show_outline=True, opacity=1.0, save_html=None)

Visualize the model in the current domain.

Parameters

input_file: str, default = “ModelData.hdf5”,

The filename that model data saved by opstool.vis.GetFEMdata.get_model_data().

Warning

Be careful not to include any path, only filename, the file will be loaded from the directory results_dir.

show_node_label: bool, default=False

Whether to display the node label.

show_ele_label: bool, default=False

Whether to display the ele label.

show_local_crd: bool, default=False

Whether to display the local axes of beam and link elements.

show_local_crd_shell: bool, default=False

Whether to display the local axes of shell elements.

local_crd_alpha: float, default=1.0

On existing displays, the scaling factor for the local axis sizes.

show_fix_node: bool, default=True

Whether to display the fix nodes.

fix_node_alpha: float, default=1.0

On existing displays, the scaling factor for the boundary symbol sizes.

show_load: bool, default = False

Whether to display node and beam element loads. The sizes of the arrow are related to the size of its load. If you want to further control the size, you can use load_alpha. Currently only supported beam element load types include <beamUniform2D, beamUniform3D, beamPoint2D, beamPoint3D>.

Note

Please make sure that all dofs (or directions) have values when adding the load or eleLoad command, even if the value is 0.0.

load_alpha: float, default = 1.0

On existing displays, the scaling factor for the load arrow sizes.

show_constrain_dof: bool, default=False

Whether to display labels for constrained degrees of freedom.

show_beam_sec: bool default = False

Whether to render the 3d section of beam or truss elements. If True, the Arg beam_sec in opstool.vis.GetFEMdata.get_model_data() must be assigned in advance.

beam_sec_paras: dict defalut = None,

A dict to control beam section render, optional key: color, opacity. Note that the backend plotly does not currently support texture.

label_size: float, default=8

The fontsize of node and ele label.

show_outline: bool, default=True

Whether to show the axis frame.

opacity: float, default=1.0

Plane and solid element transparency.

save_html: str, default=None

The html file name to output. If False, the html file will not be generated.

Note

This argument is deprecated since v0.8.0, you can call the write_html method to write an html file.

Returns

Plotly Figure object

You can call the write_html method to output an html file, and the show method will display it.

react_vis(input_file='NodeReactionStepData-1.hdf5', slider=False, direction='Fz', show_values=True, show_outline=False, save_html=None)

Plot the node reactions.

Parameters

input_filestr, optional, default=”NodeReactionStepData-1.hdf5”

The filename that eigen data saved by opstool.vis.GetFEMdata.get_node_react_step() or opstool.vis.GetFEMdata.save_resp_all().

Warning

Be careful not to include any path, only filename, the file will be loaded from the directory results_dir.

slider: bool, default=False

If True, responses in all steps will display by slider style. If False, the step that max response will display.

directionstr, optional, by default “Fz”

Type of reaction, if 2D, only be one of [‘Fx’, ‘Fy’, ‘Mz’]; if 3D, one of [‘Fx’, ‘Fy’, ‘Fz’, ‘Mx’, ‘My’, ‘Mz’]

show_valuesbool, optional, by default True

If True, will show the reaction values.

show_outline: bool, default=False

Whether to display the axes.

save_html: str, default=None

The html file name to output. If False, the html file will not be generated.

Note

This argument is deprecated since v0.8.0, you can call the write_html method to write an html file.

Returns

Plotly Figure object

You can call the write_html method to output an html file, and the show method will display it.

set_color(point='#580f41', line='#0504aa', face='#00c16e', solid='#0cb9c1', truss='#7552cc', link='#01ff07', constraint='#00ffff')

Set the color for various element types.

Paramaters

point: str, default=”#580f41”

Nodal color.

line: str, default=”#0504aa”

Line element color, including beams.

face: str, default=”#00c16e”

The color of planar elements, including 2D solid elements, plate and shell elements.

solid: str, default=”#0cb9c1”

The color of solid elements.

truss: str, default=”#7552cc”

Truss color.

link: str, default=”#01ff07”

The color of link and bearing elements.

constraint: str, default=”#00ffff”

The color of multi-point constraint.

show(fig, *args, **kwargs)

Show a figure using either the default renderer(s) or the renderer(s) specified by the renderer argument.

Note

Added since v0.8.0.

Parameters

fig : Figure object. renderer : str or None (default None)

A string containing the names of one or more registered renderers (separated by ‘+’ characters) or None. If None, then the default renderers specified in plotly.io.renderers.default are used.

validatebool (default True))

True if the figure should be validated before being shown, False otherwise.

widthint or float

An integer or float that determines the number of pixels wide the plot is. The default is set in plotly.js.

heightint or float

An integer or float that determines the number of pixels wide the plot is. The default is set in plotly.js.

configdict

A dict of parameters to configure the figure. The defaults are set in plotly.js.

Returns

None

write_html(fig, filepath, **kwargs)

Write a figure to an HTML file representation.

Note

Added since v0.8.0. The purpose is to replace the argument save_html in various visualization method.

Parameters

fig: Figure object. filepath: str, output file path.

A string representing a local file path or a writeable object (e.g. a pathlib.Path object or an open file descriptor).

kwargs:

Available key parameters see https://plotly.com/python-api-reference/generated/plotly.io.write_html.html?highlight=write#plotly.io.write_html.