build_structures_set

Command-line usage

usage: cell build_structures_set [-h] [-ssfp sset.db] [-sf structure.json]
                                 basepath plat_filepath

positional arguments:
  basepath              Either: - path to a folder containing integer-named
                        subfolders (see
                        :func:`clusterx.utils.list_integer_named_folders`), or
                        - a list/tuple of explicit structure file paths to add
                        directly. When a list/tuple is provided, folder
                        discovery is skipped and the provided file paths are
                        used as-is.
  plat_filepath         Path to a serialized parent lattice object. If
                        ``basepath`` is a folder path, this path is resolved
                        relative to it. If ``basepath`` is a list/tuple of
                        structure file paths, this path is used directly. All
                        structures to be included must derive from this parent
                        lattice.

options:
  -h, --help            show this help message and exit
  -ssfp, --sset-filepath sset.db
                        file path for writing the StructuresSet database file.
  -sf, --structure-fname structure.json
                        Name of the structure file inside every discovered
                        folder (default: structure.json). Ignored when
                        basepath is a list/tuple of explicit structure file
                        paths.

Arguments and behavior

clusterx.cli.build_structures_set.build_structures_set(basepath, plat_filepath, sset_filepath='sset.db', structure_fname='structure.json')

Build a StructuresSet from either discovered folders or explicit structure files.

Supported modes:

  1. basepath is a folder path: discover integer-named subfolders and load structure_fname from each one.

  2. basepath is a list/tuple of structure file paths: skip discovery and load each provided file path directly (structure_fname is ignored).