rmgpy.molecule.Molecule

class rmgpy.molecule.Molecule

A representation of a molecular structure using a graph data type, extending the Graph class. The atoms and bonds attributes are aliases for the vertices and edges attributes. Other attributes are:

Attribute Type Description
symmetryNumber int The (estimated) external + internal symmetry number of the molecule
multiplicity int The multiplicity of this species, multiplicity = 2*total_spin+1

A new molecule object can be easily instantiated by passing the SMILES or InChI string representing the molecular structure.

addAtom()

Add an atom to the graph. The atom is initialized with no bonds.

addBond()

Add a bond to the graph as an edge connecting the two atoms atom1 and atom2.

addEdge()

Add an edge to the graph. The two vertices in the edge must already exist in the graph, or a ValueError is raised.

addVertex()

Add a vertex to the graph. The vertex is initialized with no edges.

calculateCp0()

Return the value of the heat capacity at zero temperature in J/mol*K.

calculateCpInf()

Return the value of the heat capacity at infinite temperature in J/mol*K.

calculateSymmetryNumber()

Return the symmetry number for the structure. The symmetry number includes both external and internal modes.

clearLabeledAtoms()

Remove the labels from all atoms in the molecule.

connectTheDots()

Delete all bonds, and set them again based on the Atoms’ coords. Does not detect bond type.

containsLabeledAtom()

Return True if the molecule contains an atom with the label label and False otherwise.

copy()

Create a copy of the current graph. If deep is True, a deep copy is made: copies of the vertices and edges are used in the new graph. If deep is False or not specified, a shallow copy is made: the original vertices and edges are used in the new graph.

countInternalRotors()

Determine the number of internal rotors in the structure. Any single bond not in a cycle and between two atoms that also have other bonds are considered to be internal rotors.

deleteHydrogens()

Irreversibly delete all non-labeled hydrogens without updating connectivity values. If there’s nothing but hydrogens, it does nothing. It destroys information; be careful with it.

draw()

Generate a pictorial representation of the chemical graph using the draw module. Use path to specify the file to save the generated image to; the image type is automatically determined by extension. Valid extensions are .png, .svg, .pdf, and .ps; of these, the first is a raster format and the remainder are vector formats.

findIsomorphism()

Returns True if other is isomorphic and False otherwise, and the matching mapping. The initialMap attribute can be used to specify a required mapping from self to other (i.e. the atoms of self are the keys, while the atoms of other are the values). The returned mapping also uses the atoms of self for the keys and the atoms of other for the values. The other parameter must be a Molecule object, or a TypeError is raised.

findSubgraphIsomorphisms()

Returns True if other is subgraph isomorphic and False otherwise. Also returns the lists all of valid mappings. The initialMap attribute can be used to specify a required mapping from self to other (i.e. the atoms of self are the keys, while the atoms of other are the values). The returned mappings also use the atoms of self for the keys and the atoms of other for the values. The other parameter must be a Group object, or a TypeError is raised.

fromAdjacencyList()

Convert a string adjacency list adjlist to a molecular structure. Skips the first line (assuming it’s a label) unless withLabel is False.

fromAugmentedInChI()

Convert an Augmented InChI string aug_inchi to a molecular structure.

fromInChI()

Convert an InChI string inchistr to a molecular structure.

fromSMARTS()

Convert a SMARTS string smartsstr to a molecular structure. Uses RDKit to perform the conversion. This Kekulizes everything, removing all aromatic atom types.

fromSMILES()

Convert a SMILES string smilesstr to a molecular structure.

fromXYZ()

Create an RMG molecule from a list of coordinates and a corresponding list of atomic numbers. These are typically received from CCLib and the molecule is sent to ConnectTheDots so will only contain single bonds.

getAllCycles()

Given a starting vertex, returns a list of all the cycles containing that vertex.

This function returns a duplicate of each cycle because [0,1,2,3] is counted as separate from [0,3,2,1]

getAllCyclesOfSize()

Return a list of the all non-duplicate rings with length ‘size’. The algorithm implements was adapted from a description by Fan, Panaye, Doucet, and Barbu (doi: 10.1021/ci00015a002)

B. T. Fan, A. Panaye, J. P. Doucet, and A. Barbu. “Ring Perception: A New Algorithm for Directly Finding the Smallest Set of Smallest Rings from a Connection Table.” J. Chem. Inf. Comput. Sci. 33, p. 657-662 (1993).

getAllCyclicVertices()

Returns all vertices belonging to one or more cycles.

getAllPolycyclicVertices()

Return all vertices belonging to two or more cycles, fused or spirocyclic.

getAromaticSSSR()

Returns the smallest set of smallest aromatic rings as a list of atoms and a list of bonds

Identifies rings using Graph.getSmallestSetOfSmallestRings(), then uses RDKit to perceive aromaticity. RDKit uses an atom-based pi-electron counting algorithm to check aromaticity based on Huckel’s Rule. Therefore, this method identifies “true” aromaticity, rather than simply the RMG bond type.

The method currently restricts aromaticity to six-membered carbon-only rings. This is a limitation imposed by RMG, and not by RDKit.

getBond()

Returns the bond connecting atoms atom1 and atom2.

getBonds()

Return a list of the bonds involving the specified atom.

getDeterministicSmallestSetOfSmallestRings()

Modified Graph method getSmallestSetOfSmallestRings by sorting calculated cycles by short lenth and then high atomic number instead of just short length (for cases where multiple cycles with same length are found, getSmallestSetOfSmallestRings outputs non-determinstically ).

For instance, molecule with this SMILES: C1CC2C3CSC(CO3)C2C1, will have non-deterministic output from getSmallestSetOfSmallestRings, which leads to non-deterministic bycyclic decomposition Using this new method can effectively prevent this situation.

getDisparateRings()

Return a list of distinct polycyclic and monocyclic rings within the graph. There is some code duplication in this function in order to maximize speed up so as to call self.getSmallestSetOfSmallestRings() only once.

Returns: monocyclicRingsList, polycyclicRingsList

getEdge()

Returns the edge connecting vertices vertex1 and vertex2.

getEdges()

Return a list of the edges involving the specified vertex.

getFingerprint()

Return a string containing the “fingerprint” used to accelerate graph isomorphism comparisons with other molecules. The fingerprint is a short string containing a summary of selected information about the molecule. Two fingerprint strings matching is a necessary (but not sufficient) condition for the associated molecules to be isomorphic.

getFormula()

Return the molecular formula for the molecule.

getLabeledAtom()

Return the atoms in the molecule that are labeled.

getLabeledAtoms()

Return the labeled atoms as a dict with the keys being the labels and the values the atoms themselves. If two or more atoms have the same label, the value is converted to a list of these atoms.

getMolecularWeight()

Return the molecular weight of the molecule in kg/mol.

getMonocyclicRings()

Return a list of cycles that are monocyclic.

getNetCharge()

Iterate through the atoms in the structure and calculate the net charge on the overall molecule.

getNumAtoms()

Return the number of atoms in molecule. If element is given, ie. “H” or “C”, the number of atoms of that element is returned.

getPolycyclicRings()

Return a list of cycles that are polycyclic. In other words, merge the cycles which are fused or spirocyclic into a single polycyclic cycle, and return only those cycles. Cycles which are not polycyclic are not returned.

getRadicalAtoms()

Return the atoms in the molecule that have unpaired electrons.

getRadicalCount()

Return the total number of radical electrons on all atoms in the molecule. In this function, monoradical atoms count as one, biradicals count as two, etc.

getSmallestSetOfSmallestRings()

Return a list of the smallest set of smallest rings in the graph. The algorithm implements was adapted from a description by Fan, Panaye, Doucet, and Barbu (doi: 10.1021/ci00015a002)

B. T. Fan, A. Panaye, J. P. Doucet, and A. Barbu. “Ring Perception: A New Algorithm for Directly Finding the Smallest Set of Smallest Rings from a Connection Table.” J. Chem. Inf. Comput. Sci. 33, p. 657-662 (1993).

getSymmetryNumber()

Returns the symmetry number of Molecule. First checks whether the value is stored as an attribute of Molecule. If not, it calls the calculateSymmetryNumber method.

getURL()

Get a URL to the molecule’s info page on the RMG website.

hasAtom()

Returns True if atom is an atom in the graph, or False if not.

hasBond()

Returns True if atoms atom1 and atom2 are connected by an bond, or False if not.

hasEdge()

Returns True if vertices vertex1 and vertex2 are connected by an edge, or False if not.

hasVertex()

Returns True if vertex is a vertex in the graph, or False if not.

isAromatic()

Returns True if the molecule is aromatic, or False if not. Iterates over the SSSR’s and searches for rings that consist solely of Cb atoms. Assumes that aromatic rings always consist of 6 atoms. In cases of naphthalene, where a 6 + 4 aromatic system exists, there will be at least one 6 membered aromatic ring so this algorithm will not fail for fused aromatic rings.

isArylRadical()

Return True if the molecule only contains aryl radicals, ie. radical on an aromatic ring, or False otherwise.

isAtomInCycle()

Return True if atom is in one or more cycles in the structure, and False if not.

isBondInCycle()

Return True if the bond between atoms atom1 and atom2 is in one or more cycles in the graph, or False if not.

isCyclic()

Return True if one or more cycles are present in the graph or False otherwise.

isEdgeInCycle()

Return True if the edge between vertices vertex1 and vertex2 is in one or more cycles in the graph, or False if not.

isIsomorphic()

Returns True if two graphs are isomorphic and False otherwise. The initialMap attribute can be used to specify a required mapping from self to other (i.e. the atoms of self are the keys, while the atoms of other are the values). The other parameter must be a Molecule object, or a TypeError is raised. Also ensures multiplicities are also equal.

isLinear()

Return True if the structure is linear and False otherwise.

isMappingValid()

Check that a proposed mapping of vertices from self to other is valid by checking that the vertices and edges involved in the mapping are mutually equivalent.

isRadical()

Return True if the molecule contains at least one radical electron, or False otherwise.

isSubgraphIsomorphic()

Returns True if other is subgraph isomorphic and False otherwise. The initialMap attribute can be used to specify a required mapping from self to other (i.e. the atoms of self are the keys, while the atoms of other are the values). The other parameter must be a Group object, or a TypeError is raised.

isVertexInCycle()

Return True if the given vertex is contained in one or more cycles in the graph, or False if not.

is_equal()

Method to test equality of two Molecule objects.

merge()

Merge two molecules so as to store them in a single Molecule object. The merged Molecule object is returned.

removeAtom()

Remove atom and all bonds associated with it from the graph. Does not remove atoms that no longer have any bonds as a result of this removal.

removeBond()

Remove the bond between atoms atom1 and atom2 from the graph. Does not remove atoms that no longer have any bonds as a result of this removal.

removeEdge()

Remove the specified edge from the graph. Does not remove vertices that no longer have any edges as a result of this removal.

removeVertex()

Remove vertex and all edges associated with it from the graph. Does not remove vertices that no longer have any edges as a result of this removal.

resetConnectivityValues()

Reset any cached connectivity information. Call this method when you have modified the graph.

saturate()

Saturate the molecule by replacing all radicals with bonds to hydrogen atoms. Changes self molecule object.

sortAtoms()

Sort the atoms in the graph. This can make certain operations, e.g. the isomorphism functions, much more efficient.

sortVertices()

Sort the vertices in the graph. This can make certain operations, e.g. the isomorphism functions, much more efficient.

split()

Convert a single Molecule object containing two or more unconnected molecules into separate class:Molecule objects.

toAdjacencyList()

Convert the molecular structure to a string adjacency list.

toAugmentedInChI()

Adds an extra layer to the InChI denoting the multiplicity of the molecule.

Separate layer with a forward slash character.

toAugmentedInChIKey()

Adds an extra layer to the InChIKey denoting the multiplicity of the molecule.

Simply append the multiplicity string, do not separate by a character like forward slash.

toGroup()

This method converts a list of atoms in a Molecule to a Group object.

toInChI()

Convert a molecular structure to an InChI string. Uses RDKit to perform the conversion. Perceives aromaticity.

or

Convert a molecular structure to an InChI string. Uses OpenBabel to perform the conversion.

toInChIKey()

Convert a molecular structure to an InChI Key string. Uses OpenBabel to perform the conversion.

or

Convert a molecular structure to an InChI Key string. Uses RDKit to perform the conversion.

Removes check-sum dash (-) and character so that only the 14 + 9 characters remain.

toRDKitMol()

Convert a molecular structure to a RDKit rdmol object.

toSMARTS()

Convert a molecular structure to an SMARTS string. Uses RDKit to perform the conversion. Perceives aromaticity and removes Hydrogen atoms.

toSMILES()

Convert a molecular structure to an SMILES string.

If there is a Nitrogen atom present it uses OpenBabel to perform the conversion, and the SMILES may or may not be canonical.

Otherwise, it uses RDKit to perform the conversion, so it will be canonical SMILES. While converting to an RDMolecule it will perceive aromaticity and removes Hydrogen atoms.

toSingleBonds()

Returns a copy of the current molecule, consisting of only single bonds.

This is useful for isomorphism comparison against something that was made via fromXYZ, which does not attempt to perceive bond orders

update()

Update connectivity values, atom types of atoms. Update multiplicity, and sort atoms using the new connectivity values.

updateAtomTypes()

Iterate through the atoms in the structure, checking their atom types to ensure they are correct (i.e. accurately describe their local bond environment) and complete (i.e. are as detailed as possible).

updateConnectivityValues()

Update the connectivity values for each vertex in the graph. These are used to accelerate the isomorphism checking.

updateLonePairs()

Iterate through the atoms in the structure and calculate the number of lone electron pairs, assuming a neutral molecule.

updateMultiplicity()

Update the multiplicity of a newly formed molecule.