class matlantis_features.features.md.post_features.nemd_viscosity.PostNEMDViscosityFeatureResult(viscosity: Dict[str, List[float]], viscosity_std: Dict[str, List[float]], slab_velocity_x: List[float], slab_z: List[float])#

Bases: object

A dataclass for result of PostNEMDViscosityFeature.

Methods

__init__(viscosity, viscosity_std, …)

plot([plt_name])

Plot the result.

to_dataframe([csv_name])

Convert the result to the Pandas DataFrame object.
__init__(viscosity: Dict[str, List[float]], viscosity_std: Dict[str, List[float]], slab_velocity_x: List[float], slab_z: List[float]) → None#
plot(plt_name: Optional[str] = None) → Figure#

Plot the result.

Parameters

plt_name (str or None, optional) – File name to write the plot. Supported formats include ‘png’ ‘jpg’ ‘jpeg’ ‘webp’
‘svg’ and ‘pdf’. If ‘None’ is provided, the figure will not be saved.
Defaults to None.

Returns

Resulting plotly’s graph object.

Return type

go.Figure

to_dataframe(csv_name: Optional[str] = None) → DataFrame#

Convert the result to the Pandas DataFrame object.

Parameters

csv_name (str or None, optional) – CSV file name to write the DataFrame. If None, no CSV file is generated.
Defaults to None.

Returns

Resulting Pandas DataFrame object.

Return type

pd.DataFrame

Attributes

viscosity: Dict[str, List[float]]#
viscosity_std: Dict[str, List[float]]#
slab_velocity_x: List[float]#
slab_z: List[float]#