compute_concentrations¶
Command-line usage
usage: cell compute_concentrations [-h] [-ssf sset.json] [-st 0] [-si 1]
[-cof conc.npz]
options:
-h, --help show this help message and exit
-ssf, --sset-filepath sset.json
Path to a serialized StructuresSet object. All cluster
correlations of all structures in this object are
computed and saved to a two dimensional array.
-st, --site-type 0 Site type as output by command print_plat_info
-si, --sigma 1 Integer, substitutional species. 0 pristine. 1 first
substitutional species. 2 second substitutional
species. etc.
-cof, --conc-filepath conc.npz
Path to store the computed concentrations array. The
file is saved in npz format.
Arguments and behavior
- clusterx.cli.compute_concentrations.compute_concentrations(sset_filepath='sset.json', site_type=0, sigma=1, conc_filepath='conc.npz')¶
Compute concentrations