mdsuite.visualizer.d2_data_visualization module

MDSuite: A Zincwarecode package.

License

This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html

SPDX-License-Identifier: EPL-2.0

Copyright Contributors to the Zincwarecode Project.

Contact Information

email: zincwarecode@gmail.com github: https://github.com/zincware web: https://zincwarecode.com/

Citation

If you use this module please cite us with:

Summary

class mdsuite.visualizer.d2_data_visualization.DataVisualizer2D(title: str, path: Path)[source]

Bases: object

Visualizer for two-dimensional data.

construct_plot(x_data: Union[list, ndarray], y_data: Union[list, ndarray], x_label: str, y_label: str, title: str, layouts: Optional[List] = None) → figure[source]

Generate a plot.

Parameters:

  • x_data (Union[list, np.ndarray, tf.Tensor]) – data to plot along the x axis.

  • y_data (Union[list, np.ndarray, tf.Tensor]) – data to plot along the y axis.

  • x_label (str) – label for the x axis

  • y_label (str) – label of the y axis.

  • title (str) – name of the specific plot.

Returns:

figure – A bokeh figure object.

Return type:

figure

grid_show(figures: list)[source]

Display a list of figures in a grid.

Parameters:

figures (list) – A list of figures to display.