casm.info.get_neighbor_list_info

casm.info.get_neighbor_list_info(prim=None, root=None, properties=[], **kwargs)[source]

Get neighbor list information for a supercell

Parameters:

  • prim (dict of BasicStructure (optional, default=None)) – Dict containing the definition of a “prim”, in the `CASM BasicStructure JSON format`_. May be None if root provided.

  • root (str (optional, default=os.getcwd())) – Use the prim of a CASM project located at root.

  • properties (list of str (default=[])) – A list of properties to return

  • **kwargs (key-value pairs) – Additional key-value pairs to be added to the input. See neighbor_list_info_desc for options.

Returns:

output (Dict containing results.)