build_superstructure

Command-line usage

usage: cell build_superstructure [-h] [-sssh 2] [-ssfp None]
                                 structure_filepath

positional arguments:
  structure_filepath    Path to a serialized Structure object (.json or
                        .pickle).

options:
  -h, --help            show this help message and exit
  -sssh, --ss-shape 2   Superstructure shape. Can be an integer, a 3-vector,
                        or a 3x3 integer matrix. Examples: 2, [2,2,2],
                        [[2,0,0],[0,2,0],[0,0,2]].
  -ssfp, --superstructure-filepath None
                        Output filepath for the generated superstructure. By
                        default, this is <input_name>_superstructure<ext>.

Arguments and behavior

clusterx.cli.build_superstructure.build_superstructure(structure_filepath, ss_shape='2', superstructure_filepath=None)

Build and serialize a superstructure from a serialized Structure object.