nanome.api.structure.residue module¶

class Residue[source]¶

Bases: nanome._internal.structure.models._Residue, nanome.api.structure._deprecated.ResidueDeprecated, nanome.api.structure.base.Base

Represents a Residue. Contains atoms. Chains contain residues.

class RibbonMode¶

Bases: enum.IntEnum

Ribbon display modes.

To be used with structure.Residue().ribbon_mode

AdaptiveTube = 1¶

Coil = 2¶

SecondaryStructure = 0¶

class SecondaryStructure¶

Bases: enum.IntEnum

Secondary structure types.

To be used with structure.Residue().secondary_structure

Coil = 1¶

Helix = 3¶

Sheet = 2¶

Unknown = 0¶

add_atom(atom)[source]¶

Add an atom to this residue

Parameters:	atom (`Atom`) – Atom to add to the residue

add_bond(bond)[source]¶

Add a bond to this residue

Parameters:	bond (`Bond`) – Bond to add to the residue

atoms¶: The list of atoms within this residue

bonds¶: The list of bonds within this residue

chain¶: Chain that the residue is part of

complex¶: Complex that the residue is part of

ignored_alt_locs¶

Alternate Locations that should not be rendered.

Type:	list<:class:`str>`

label_text¶

Represents the text that would show up if residue is labeled.

Type:	`str`

labeled¶

Represents if the residue has a label or not. If it does, show the label.

Type:	`bool`

molecule¶: Molecule that the residue is part of

name¶

Represents the name of the residue

Type:	`str`

remove_atom(atom)[source]¶

Remove an atom from this residue

Parameters:	atom (`Atom`) – Atom to remove from the residue

remove_bond(bond)[source]¶

Remove a bond from this residue

Parameters:	bond (`Bond`) – Bond to remove from the residue

ribbon_color¶

Color of the ribbon residue

Type:	`Color`

ribbon_mode¶

Represents how the residue ribbon should be shown

Type:	`RibbonMode`

ribbon_size¶

ribboned¶

secondary_structure¶

The secondary structure of the residue

Type:	`SecondaryStructure`

serial¶

type¶