simdesign.utils.plotter

This modules provide a Plotter for OpenSeesPy models. The module is inspired by the vfo package of Anurag Upadhyay. https://github.com/u-anurag

simdesign.utils.plotter.plot_model(show_nodes='no', show_nodetags='no', show_eletags='no', font_size=10, set_view='3D', ele_groups=None, line_width=1, filename=None, show=True)[source]

Plot the numerical model of the structure.

Parameters:

  • show_nodes (Literal["yes", "no"], optional) – Renders nodes as spheres, by default “no”.

  • show_nodetags (Literal["yes", "no"], optional) – Displays node tags if “yes”, by default “no”.

  • show_eletags (Literal["yes", "no"], optional) – Displays element tags if “yes”, by default “no”.

  • font_size (int, optional) – Size of tag font, by default 10.

  • set_view (Literal["xy", "yz", "xz", "3D"] | List[float], optional) – Sets the camera view to predefined angles. Valid entries are “xy”,”yz”,”xz”,”3D”, or a list with [x,y,z] unit vector, by default “3D”.

  • ele_groups (Optional[List[List[int] | List[str]]], optional) – List of lists of elements of groups and respective colors, by default None.

  • line_width (int, optional) – Line thickness for the beam-column elements, by default 1.

  • filename (str, optional) – Filename to save an image of the mode shape, by default None.

  • show (bool, optional) – Flag for showing the figure in an interactive window, by default True.

Return type:

None

simdesign.utils.plotter.plot_mode_shape(mode_number=1, scale=10, contour='none', set_view='3D', line_width=1, contour_limits=None, filename=None, show=True)[source]

Plot the shape of the specified mode.

Parameters:

  • mode_number (int, optional) – Number of the mode being shown, by default 1.

  • scale (int, optional) – Scale factor to be applied to the deformed shape, by default 10.

  • contour (Literal["x", "y", "x", "none"], optional) – Contours of displacement in x, y, or z. By default “none”.

  • set_view (Literal["xy", "yz", "xz", "3D"] | List[float], optional) – Sets the camera view to predefined angles. Valid entries are “xy”,”yz”,”xz”,”3D”, or a list with [x,y,z] unit vector. by default “3D”.

  • line_width (int, optional) – Line thickness for the beam-column elements, by default 1.

  • contour_limits (list, optional) – A list of minimum and maximum limits of the displacement contours, by default None.

  • filename (str, optional) – Filename to save an image of the mode shape, by default None.

  • show (bool, optional) – Flag for showing the figure in an interactive window, by default True.

Return type:

None