api

A module containing the API for reading virial and stress files.

Summary

Functions:

read_stress_file	Read a stress file.
read_virial_file	Read a virial file.

Reference

read_stress_file(filename: str) → list

Read a stress file.

Parameters:

filename (str) – The name of the file to read.

Returns:

The stress data.

Return type:

List[np.ndarray]

read_virial_file(filename: str) → list

Read a virial file.

Parameters:

filename (str) – The name of the file to read.

Returns:

The virial data.

Return type:

List[np.ndarray]