build_cpool¶
Command-line usage
usage: cell build_cpool [-h] [-pms None] [-ssf None] [-plf None] [-p None]
[-me 0] [-c cpool.json] [-v 0]
npoints radii
positional arguments:
npoints The number of points in the clusters being built.
radii Corresponding cluster radii.
options:
-h, --help show this help message and exit
-pms, --post-manual-select None
List of cluster indices to manually select clusters
out of the generated pool.
-ssf, --sset-filepath None
Path to a serialized StructuresSet object to get the
parent lattice from it.
-plf, --plat-filepath None
Path to a serialized ParentLattice object to get the
parent lattice from it.
-p, --psc None Definition of a super cell where to find clusters, in
terms of the parent lattice. For a precise definition
look into the parameter p of the SuperCell class of
CELL.
-me, --method 0 Method to use to find clusters.
-c, --cpool-filepath cpool.json
Filepath where to store the generated pool of
clusters.
-v, --vacancy-atomic-number 0
Look documentation for variable vacancy_atomic_number
in ClustersPool class.
Arguments and behavior
- clusterx.cli.build_cpool.build_cpool(npoints, radii, post_manual_select=None, sset_filepath=None, plat_filepath=None, psc=None, method=0, cpool_filepath='cpool.json', vacancy_atomic_number=0)¶
Build a pool of clusters.
- Parameters:
- npointslist of int or str
A list of integers or a string representation of the list.
- radiilist of float or str
A list of floats or a string representation of the list.
- post_manual_selectlist of int
List of cluster indices to manually select clusters out of the generated pool.
- sset_filepathstr, optional
Path to the structure set file (optional).
- plat_filepathstr, optional
Path to the parent lattice file (optional).
- psc
Supercell definition (default: 1).
- methodint
Method ID used to construct clusters, default 0.
- cpool_filepathstr
Output filepath for the cluster pool, default “cpool.json”.
- vacancy_atomic_numberint
Atomic number for vacancy site, default 0.