nvalchemi.csp.get_space_group_candidates#

nvalchemi.csp.get_space_group_candidates(num_operations, *, crystal_system=None, sohncke_only=False)[source]#

Return space-group numbers with a requested operation count.

Parameters:
  • num_operations (int) – Positive required number of symmetry operations.

  • crystal_system (CrystalSystem, optional) – Restrict results to one crystal system.

  • sohncke_only (bool, default=False) – Keep only groups whose symmetry-generated copies preserve handedness.

Returns:

candidates – Compatible International numbers in ascending order; K may be zero.

Return type:

torch.Tensor, shape [K], dtype=torch.int32

Raises:
  • TypeError – If num_operations is not a non-boolean integer, or a filter has the wrong type.

  • ValueError – If num_operations is not positive.