crystal_space_group Input Terms

Calculation Metadata

Specifies metadata descriptors common to all calculation styles.

  • branch: A metadata group name that the calculation can be parsed by. Primarily meant for differentiating runs with different settings parameters.

Initial System Configuration

Specifies the file and options to load for the initial atomic configuration.

  • load_file: The path to the initial configuration file to load.

  • load_style: The atomman.load() style indicating the format of the load_file.

  • load_options: A space-delimited list of key-value pairs for optional style-specific arguments used by atomman.load().

  • family: A metadata descriptor for relating the load_file back to the original crystal structure or prototype that the load_file was based on. If not given, will use the family field in load_file if load_style is ‘system_model’, or the file’s name otherwise.

  • symbols: A space-delimited list of the potential’s atom-model symbols to associate with the loaded system’s atom types. Required if load_file does not contain symbol/species information.

  • box_parameters: Specifies new box parameters to scale the loaded configuration by. Can be given either as a list of three or six numbers: ‘a b c’ for orthogonal boxes, or ‘a b c alpha beta gamma’ for triclinic boxes. The a, b, c parameters are in units of length and the alpha, beta, gamma angles are in degrees.

Input/Output Units

Specifies the default units to use for the other input keys and to use for saving to the results file.

  • length_unit: The unit of length to use. Default value is ‘angstrom’.

  • pressure_unit: The unit of pressure to use. Default value is ‘GPa’.

  • energy_unit: The unit of energy to use. Default value is ‘eV’.

  • force_unit: The unit of force to use. Default value is ‘eV/angstrom’.

Run Parameters

  • symmetryprecision: The precision tolerance used for the atomic positions and box dimensions for determining symmetry elements. Default value is ‘0.01 angstrom’.

  • primitivecell: A boolean flag indicating if the returned unit cell is to be primitive (True) or conventional (False). Default value is False.

  • idealcell: A boolean flag indicating if the box dimensions and atomic positions are to be idealized based on the space group (True) or averaged based on their actual values (False). Default value is True.