Reference navigation
PYTHON API · v0.9.1
Reference manual
Classes, functions, and methods for building protein animations. Browse a module below, or search for an API name such as Protein.surface.
For installation and step-by-step examples, start with the user guides. API signatures and defaults are read from the package source.
Module index
proteinmotion.scene
Build a timeline, evaluate frames, and export videos.
proteinmotion.protein
Load structures, choose representations, and change coordinates or appearance.
proteinmotion.camera
Frame proteins and regions, orbit, zoom, and set depth cueing.
proteinmotion.animation
Move objects, change representations, and interpolate coordinates.
proteinmotion.styling
Animate atom and residue colors and transparency.
proteinmotion.annotations
Write text, label amino acids, and connect labels to regions.
proteinmotion.regions
Select atoms and residues and mark regions in 3D.
proteinmotion.trajectory
Read and align NMR ensembles, NumPy frames, and MD trajectories.
proteinmotion.matching
Match ordered Cα subsets and save residue correspondences.
proteinmotion.backbone
Move matched residues and fade unmatched parts between structures.
proteinmotion.distances
Measure atoms or residues with 2D or 3D lines.
proteinmotion.interactions
Compute and display hydrogen bonds and screened Coulomb interactions.
proteinmotion.rates
Map animation progress to eased progress.
proteinmotion.renderer
Render frames directly with a reusable GPU renderer.
proteinmotion.eevee
Render through Blender with depth of field and smooth group fades.
proteinmotion.properties
Map measured residue values to colors and cartoon thickness.
proteinmotion.plots
Display time-series traces, contact maps, sequence strips, and color legends.
proteinmotion.density
Read MRC/CCP4 grids, extract contours, and animate slices.
Alphabetical index
| Name | Description |
|---|---|
| Animateclass | Build a fluent protein or camera animation through the .animate property. |
| Animationclass | Base class for animations evaluated by the scene timeline. |
| Annotationclass | Base class for text and lines drawn over the image. |
| AnnotationAnimateclass | Build position, offset, and opacity animations for annotations. |
| BackboneMorphclass | Move matched backbone residues in order and fade unmatched residues. |
| Calloutclass | Connect an image label to a selected region with a line. |
| Cameraclass | A perspective camera with orbit, zoom, framing, depth cueing, and EEVEE lens focus. |
| charges_from_pqr()function | Match PQR charges to the protein’s atom identities. |
| ColorByPropertyclass | Animate property-based residue colors and optional cartoon thickness. |
| Colorizeclass | Animate a tint on a whole protein or a selected region. |
| ColorLegendclass | A horizontal color bar with numeric limits and measurement units. |
| ColorScaleclass | A fixed linear scale mapping scalar values to RGB colors. |
| ContactMapclass | A live binary Cα contact map with linked residue markers. |
| ContactMatchclass | Store an ordered residue correspondence and its search report. |
| Deformclass | Interpolate coordinates toward the result of a user-supplied function. |
| DensityMapclass | An immutable scalar grid with physical coordinates and optional periodic boundaries. |
| DensitySliceclass | A trilinearly sampled map plane with a fixed color scale and animated position. |
| DensitySurfaceclass | A cached contour mesh with animated level, opacity, and transforms. |
| Distanceclass | Draw a distance line between two atom or residue selections. |
| ease_in_out_sine()function | Apply sinusoidal easing that starts and ends slowly. |
| EEVEEclass | Keep one Blender process alive while rendering multiple frames. |
| EEVEEOptionsclass | Configure the optional EEVEE renderer. Blender 4.5+ is installed separately. |
| Electrostaticsclass | Compute screened Coulomb pair energies and electrostatic potential. |
| FadeInclass | Fade a protein or annotation from transparent to its current opacity. |
| FadeOutclass | Fade a protein or annotation to zero opacity. |
| find_blender()function | Locate the Blender executable and explain how to install it if absent. |
| Focusclass | Animate the camera to a protein or selected region. |
| FocusPullclass | Animate lens focus to a protein, residue selection or world point. |
| HydrogenBondsclass | Detect hydrogen bonds from donor–acceptor distance and hydrogen geometry. |
| Interactionclass | An immutable record for one detected molecular interaction. |
| InteractionHighlightclass | Draw selected hydrogen-bond or electrostatic contact lines. |
| linear()function | Return progress unchanged. |
| match_backbones()function | Find the largest ordered residue match under a contact-error limit. |
| Morphclass | Interpolate matching atoms to a protein or coordinate array. |
| PlayTrajectoryclass | Interpolate through coordinate states in a trajectory. |
| Proteinclass | A molecular structure with fixed atom identities, coordinates, and display settings. |
| ProteinSceneclass | Define a protein animation as a sequence of play() and wait() calls. |
| Regionclass | A selection of atoms that follows its parent protein’s coordinates. |
| RegionAnimateclass | Create styling animations through region.animate. |
| RegionHighlightclass | Draw a sphere, wire box, or atom halos around a region. |
| Rendererclass | Render protein and annotation objects with a reusable GPU renderer. |
| Representationclass | Transition between cartoon, ribbon, ball-and-stick, and surface. |
| ResidueLabelclass | Label one amino acid at its projected Cα position. |
| ResidueLabelsclass | Label several residues and adjust their positions to reduce overlap. |
| ResidueValuesclass | One measurement per topology residue, with identity checks and optional units. |
| Rotateclass | Rotate a protein around its molecular centroid. |
| Scenealias | Alias for ProteinScene. |
| SequenceTrackclass | A sequence with a thin strip of current structure colors or a fixed numerical property. |
| SetOpacityclass | Animate transparency on a whole protein or a selected region. |
| smooth()function | Apply quintic easing with zero endpoint speed and acceleration. |
| Textclass | Draw shaped vector text over the protein image. |
| there_and_back()function | Move smoothly from 0 to 1 and back to 0 over one clip. |
| TimeSeriesPlotclass | A vector trace with a cursor linked to scene time or a protein trajectory. |
| Trajectoryclass | A random-access sequence of coordinate frames in ångströms. |
| Unwriteclass | Erase glyph fills and then their outlines. |
| Writeclass | Draw text outlines and then fill the glyphs. |