build_parent_lattice¶
Command-line usage
usage: cell build_parent_lattice [-h] [-s Si,Ge] [-f plat.json]
options:
-h, --help show this help message and exit
-s, --species Si,Ge Comma-separated list of species, e.g., Si,Ge
-f, --filepath plat.json
File path where to serialize the generated parent
lattice
Arguments and behavior
- clusterx.cli.build_parent_lattice.build_parent_lattice(species='Si,Ge', filepath='plat.json')¶
Build parent lattice
This command constructs a single-sublattice parent lattice. It generates a lattice for the first species using ASE’s
ase.build.bulk()function provided in the input list and creates aParentLatticeobject where all lattice sites are associated with the same set of possible species.The resulting parent lattice is serialized to a JSON file.
- Parameters:
- speciesstr, optional
Comma-separated list of chemical species to include in the parent lattice. The first species is used to generate the underlying atomic structure. Default is
"Si,Ge".- filepathstr, optional
File path to which the generated
ParentLatticeis serialized. Default is"plat.json".
Notes
This command is primarily intended for demonstration or testing. For realistic parent lattices, users should define them explicitly using the
ParentLatticeinterface.Examples
$ clusterx build_parent_lattice -s Si,Ge -f plat.json