Skip to content

API Reference

Auto-generated reference for every public symbol, with typed signatures throughout. Start from the tables below: find your task, get the symbol and its package.

Index of Operations and Symbols

Operation Primary symbols Package
Construct a molecule from atoms and bonds Atomistic, def_atom, def_bond Core
Store tabular molecular data Block, Frame Core
Define a periodic simulation cell Box Core
Represent a time-ordered frame sequence Trajectory Core
Perceive angles/dihedrals in place; k-hop bond-graph queries get_topo, get_topo_neighbors, get_topo_distances Core
Define and query force field parameters ForceField, Style, Type Core
Parse SMILES / SMARTS mp.io.read_smiles, SmilesIR, SmartsPattern Parser
Perceive hydrogens / aromaticity / rings Perceive, RingInfo Core
Execute a chemical reaction (bond formation / removal) Reaction, GraphAssembler, Selector Builder
Generate fix bond/react pre/post topology templates BondReactTemplate, write_bond_react_map IO
Assemble polymer chains MonomerLibrary, PolymerBuilder, Selector, Placer Builder
Pack molecules into a simulation box molpack.Molpack, Target, restraints Pack
Generate 3D conformers from a molecular graph Conformer Conformer
Assign force field atom types via SMARTS matching OPLSAATypifier, ClpTypifier, MMFFTypifier Typifier
Evaluate bond, angle, and pair potentials BondHarmonicStyle, LJ126Style, Potentials Potential
Read and write molecular files (PDB, LAMMPS, GRO, …) read_pdb, write_lammps_data, read_xml_forcefield I/O
Bridge to a third-party library (in-memory) Adapter, RDKitAdapter (optional example) Adapter
Invoke external CLI tools (antechamber, tleap) Wrapper, AntechamberWrapper Wrapper
Build polymer chains and crosslinked networks PolymerBuilder, GraphAssembler, Conformer Builder
Compute mean-squared displacement, correlations, RDF, clustering MSD, Onsager, RDF Compute
Locate bundled data files and built-in force fields get_forcefield_path, get_path Data
Generate LAMMPS, CP2K, or OpenMM input decks LAMMPSEngine, CP2KEngine, OpenMMEngine Engine

Package Responsibilities

Package Responsibility
Core Foundational data structures: Atomistic, Frame, Block, Box, Trajectory, Entity/Link, Region, UnitSystem, ForceField
Parser SMILES / SMARTS (SmilesIR, SmartsPattern); moltemplate
Builder Polymer system construction: builders, port connectors, geometric placers
Pack Spatial packing via molpack (molcrafts-molpack)
Conformer 3D conformer generation from molecular graphs
Typifier Atom typing for OPLS-AA, CL&P, and MMFF (GAFF via AmberTools wrappers)
Potential Numerical potential kernels for bonds, angles, dihedrals, and non-bonded interactions
I/O Format-specific readers and writers for molecular data, force fields, and trajectories
Adapter Optional in-memory bridge to RDKit (worked example)
Wrapper Subprocess interfaces for AmberTools command-line executables
Engine Simulation engine abstractions for LAMMPS, CP2K, OpenMM
Optimization Potential wrappers for geometry optimization workflows
Compute Trajectory analysis: MSD, Onsager, transport, dielectric, RDF, clustering, …
Data Locators for bundled data files and built-in force fields