Skip to main content

Parse HELM strings into RDKit molecules

Project description

helmkit

A Python library for converting HELM (Hierarchical Editing Language for Macromolecules) notation to RDKit molecules.

Basic Usage

from helmkit import Molecule

# Create a molecule from a HELM string
helm_string = "PEPTIDE1{A.R.G}$$$"
molecule = Molecule(helm_string)

# Access the RDKit molecule object
rdkit_mol = molecule.mol

Quick Example

from helmkit import Molecule
from rdkit.Chem import AllChem, Draw

# Create a simple tripeptide (Ala-Arg-Gly)
molecule = Molecule("PEPTIDE1{A.R.G}$$$")

# Generate 2D coordinates for visualization
AllChem.Compute2DCoords(molecule.mol)

# Save the image
img = Draw.MolToImage(molecule.mol)
img.save("tripeptide.png")

Understanding HELM Notation

HELM (Hierarchical Editing Language for Macromolecules) is a notation for representing complex biomolecules. A basic HELM string has the following format:

PEPTIDE1{A.R.G}$PEPTIDE2{S.G.T}$PEPTIDE1,PEPTIDE2,1:R1-4:R3$$

Where:

  • PEPTIDE1{A.R.G} defines the first chain (a peptide with amino acids A, R, G)
  • PEPTIDE2{S.G.T} defines the second chain
  • PEPTIDE1,PEPTIDE2,1:R1-4:R3 defines a connection between the chains (R1 of residue 1 in PEPTIDE1 connects to R3 of residue 4 in PEPTIDE2)
  • $ characters separate different sections of the HELM string

Using Custom Monomer Data

By default, helmkit uses the monomer data in helmkit/data/monomers.sdf. To use a custom SDF file:

from helmkit import Molecule, load_monomer_library

# Load your custom monomer data
custom_sdf_path = "/path/to/your/custom_monomers.sdf"
custom_monomers = load_monomer_library(custom_sdf_path)

# Create molecule with custom monomer data
molecule = Molecule("PEPTIDE1{A.R.G}$$$", monomer_df=custom_monomers)

SDF File Structure Requirements

The SDF file containing monomer data must have the following properties for each molecule:

Required Properties:

  • symbol: A unique identifier for the monomer (e.g., "A" for alanine)
  • m_RgroupIdx: Comma-separated list of R-group atom indices (e.g., "1,2,None,None")

Optional Properties:

  • m_Rgroups: Comma-separated list of R-group types (e.g., "H,OH,None,None")
  • m_type: Monomer type (e.g., "aa" for amino acid)
  • m_subtype: Monomer subtype
  • m_abbr: Monomer abbreviation

Example SDF Entry:

Your molecule atom data here...
...

> <symbol>
A

> <m_Rgroups>
H,OH,None,None

> <m_RgroupIdx>
1,2,None,None

> <m_type>
aa

> <m_subtype>
natural

> <m_abbr>
Ala

$$$$

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

helmkit-0.2.0.tar.gz (4.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

helmkit-0.2.0-py3-none-any.whl (48.2 kB view details)

Uploaded Python 3

File details

Details for the file helmkit-0.2.0.tar.gz.

File metadata

  • Download URL: helmkit-0.2.0.tar.gz
  • Upload date:
  • Size: 4.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.2

File hashes

Hashes for helmkit-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f87a577cb39f61ed4ff61efbc247a4c19585065f6d530bf01cc82852605a2dfb
MD5 5190a2caee152fa375d8d616587d2815
BLAKE2b-256 90b2c63a870808762da07456bca5b8458cbb7142006a99097dfe44971d4f0384

See more details on using hashes here.

File details

Details for the file helmkit-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: helmkit-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 48.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.2

File hashes

Hashes for helmkit-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd1479bb649cb64a164d3238793dc96b6db6b7b095653e47410c53ee6674ddad
MD5 cfe5953fcaa5341bf6e6b7aa3fd50f1b
BLAKE2b-256 2a55a2339fcff8abf1541d4f3762192e8dbec15b052ddf59d9425f241b799742

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page