Skip to content

Base

Implementation of structure class.

Prepared

Base class for prepared structures.

get_info(context)

This function gives information about the prepared structure.

PARAMETER DESCRIPTION
context

Context object with information about the preparation.

RETURNS DESCRIPTION
dict[str, str | int | float | bool]

Dictionary with information about the preparation depending on the type of structure.

Structure(file_path=None, file_id=None)

Bases: ABC

Base class for any physical structure.

file_ext = self.file_ext.lstrip('.')

file_id = file_id

file_name = os.path.basename(file_path)

file_path = file_path

load(file_path=None, write=False, write_path=None, pdb_id=None)

Load structural data from a variety of sources.

PARAMETER DESCRIPTION
file_path

Path to file to load.

write

Keep structure in file and load when requested. If False, this will keep the structure in memory.

write_path

Path to write to file.

pdb_id

Four-letter code to load structure from RCSB.