GromacsTopologyFile#

Form adapter and capabilities for parmed.GromacsTopologyFile.

  • Technical Form Name: parmed.GromacsTopologyFile

  • Form Type: class

Added in version 1.0.0.

API documentation

  • Form adapter module: molsysmt.form.parmed_GromacsTopologyFile

Overview#

parmed.GromacsTopologyFile is a supported representation form in MolSysMT. Form adapter and capabilities for parmed.GromacsTopologyFile.

Supported attributes#

The parmed.GromacsTopologyFile form container supports a total of 43 attributes:

Category

Subcategory / Level

Supported Attributes

Topological

Atom Level

atom_index, atom_name, atom_id, atom_type

Topological

Group Level

group_index, group_name, group_id, group_type

Topological

Component Level

component_index

Topological

Chain Level

chain_index, chain_name, chain_id, chain_type

Topological

Molecule Level

molecule_index, molecule_name, molecule_id, molecule_type

Topological

Bonds & Connectivity

bond_index, bond_type, bond_order, bonded_atoms, inner_bonded_atoms, inner_bond_index, n_bonds, n_inner_bonds

Topological

Element Counts

n_atoms, n_groups, n_components, n_chains, n_molecules, n_entities, n_bonds, n_inner_bonds, n_amino_acids, n_nucleotides, n_ions, n_waters, n_small_molecules, n_peptides, n_proteins, n_dnas, n_rnas, n_lipids, n_polysaccharides, n_saccharides

Structural

Other Attributes

atom_index, n_atoms

Implemented operations#

The form adapter module molsysmt.form.parmed_GromacsTopologyFile implements the following functions and modules:

Function / Module

Description

extract()

Extracts a subset of atoms, groups, or structures into a new parmed.GromacsTopologyFile instance.

copy()

Creates an independent deep copy of the parmed.GromacsTopologyFile object in memory.

add()

Adds elements from another system into an existing parmed.GromacsTopologyFile instance.

merge()

Merges multiple systems into a single combined parmed.GromacsTopologyFile object.

append_structures()

Appends new coordinate frames or trajectories to the structures container.

get_topological_attributes

Module containing getters for topological attributes.

get_structural_attributes

Module containing getters for structural attributes.

set

Module containing setters for updating coordinates, box dimensions, or attributes in-place.

iterators

Module providing iterators for streaming trajectory frames and structures.

has_attribute()

Checks whether a specific attribute name is supported by parmed.GromacsTopologyFile.

is_form()

Returns True if the provided object is an instance of parmed.GromacsTopologyFile.

Note

Each form adapter in MolSysMT implements only the specific functions that are meaningful for its data model.

Supported conversions#

The following table lists all direct conversion functions implemented in molsysmt.form.parmed_GromacsTopologyFile:

Target Form

Form Type

API Documentation

file:top

file

to_file_top()

mdtraj.Topology

class

to_mdtraj_Topology()

molsysmt.MolSys

class

to_molsysmt_MolSys()

molsysmt.Topology

class

to_molsysmt_Topology()

openmm.Topology

class

to_openmm_Topology()

parmed.GromacsTopologyFile

class

to_parmed_GromacsTopologyFile()

parmed.Structure

class

to_parmed_Structure()

See also

Foundations & Object Architecture:

  • The Molecular System: The fundamental definition of a molecular system, forms, and attributes in MolSysMT.

  • MolSys: In-depth architectural guide on the native molsysmt.MolSys container.

  • Topology: Architectural specification of the native Topology object.

  • Structures: Architectural specification of the native Structures object.

Form Tools & Conversions: