biotite.structure.io.load_structure

biotite.structure.io.load_structure(file_path, template=None)[source]

Load an atom array or stack from a structure file without the need to manually instantiate a File object.

Internally this function uses a File object, based on the file extension. Trajectory files furthermore require specification of the template parameter.

Parameters
file_pathstr

The path to structure file.

templateAtomArray or AtomArrayStack or file-like object or str, optional

Only required when reading a trajectory file.

Returns
arrayAtomArray or AtomArrayStack

If the file contains multiple models, an AtomArrayStack is returned, otherwise an AtomArray is returned.

Raises
ValueError

If the file format (i.e. the file extension) is unknown.

TypeError

If a trajectory file is loaded without specifying the template parameter.