compute_comat

Command-line usage

usage: cell compute_comat [-h] [-ccf ccalc.pickle] [-ssf None] [-ssfs None]
                          [-dsf None] [-dsfs None] [-cmf comat] [-pn None]
                          [-u]

options:
  -h, --help            show this help message and exit
  -ccf, --ccalc-filepath ccalc.pickle
                        Path to the pickle file of a serialized
                        CorrelationsCalculator object.
  -ssf, --sset-filepath None
                        Path to a serialized StructuresSet object.
                        Correlations of all structures are computed and saved
                        as a 2D array.
  -ssfs, --sset-filepaths None
                        List of paths to serialized StructuresSet objects.
                        Correlations are concatenated in the given order.
  -dsf, --dss-filepath None
                        Path to a serialized DerivativeStructures object.
                        Correlations of all structures are computed and saved
                        as a 2D array.
  -dsfs, --dss-filepaths None
                        List of paths to serialized DerivativeStructures
                        objects. Correlations are concatenated in the given
                        order.
  -cmf, --comat-filepath comat
                        Path to store correlations matrix (extension removed,
                        saved as .txt and .npz).
  -pn, --property-name None
                        Name of the property.
  -u, --update-ccalc    Overwrite ccalc file to keep supercell cluster orbits
                        for future reuse.

Arguments and behavior

clusterx.cli.compute_comat.compute_comat(ccalc_filepath='ccalc.pickle', sset_filepath=None, sset_filepaths=None, dss_filepath=None, dss_filepaths=None, comat_filepath='comat', property_name=None, update_ccalc=False)

Compute matrix of correlations