starling.utilities.read_starling_ensemble

read_starling_ensemble(filename)

Function to read a STARLING ensemble from a file in the STARLING format (.starling) or a compressed starling file (.gzip, .xz). The .starling file is actially just a dictionary with the amino acid sequence, the distance maps, some metadata and the SSProtein object if available.

Note this determines the file type based on the extension and will raise an error if the file is not a .starling file, a a .starling.gzip or .starling.xz file.

Parameters:

filename (str) – The filename to read the ensemble from; note this should not include a file extenison and if it does this will be removed

Returns:

starling.structure.Ensemble

Return type:

The STARLING ensemble object