Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 0.7.12 instead.
Reason given by maintainers: Regression

helmkit

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

Table of Contents

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

Installation

To install helmkit, you can use either uv or pip.

With uv

uv pip install helmkit

or if you have added it as a dependency to your pyproject.toml:

uv add helmkit

Without uv

pip install helmkit

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.C}$PEPTIDE1,PEPTIDE2,1:R1-3:R3$$$V2.0

Where:

  • PEPTIDE1{A.R.G} defines the first chain (a peptide with amino acids A, R, G)
  • PEPTIDE2{S.G.C} defines the second chain
  • PEPTIDE1,PEPTIDE2,1:R1-3:R3 defines a connection between the chains (R1 of residue 1 in PEPTIDE1 connects to R3 of residue 3 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

$$$$

Parallel Processing of Peptides

For workflows involving a large number of peptides, helmkit provides a function to process them in parallel, significantly improving performance.

from helmkit import load_monomer_library
from helmkit import load_in_parallel

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

# A list of HELM strings
helm_strings = ["PEPTIDE1{A.R.G}$$$$", "PEPTIDE1{S.G.T}$$$$"]

# Process peptides in parallel
molecules = load_in_parallel(helm_strings, monomer_db)

Development Setup

To set up a development environment, first clone the repository. Then, from the root of the repository, use uv to sync the environment:

uv sync -U

Running Tests

To run the test suite, execute pytest from the root of the repository:

pytest

Metadata

Release files for helmkit 0.7.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for helmkit 0.7.5
File Size Uploaded Provenance Actions
helmkit-0.7.5.tar.gz 179.0 kB Without provenance Details for helmkit-0.7.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for helmkit 0.7.5
File Interpreter ABI Platform Actions
helmkit-0.7.5-py3-none-any.whl Python 3 none any Details for helmkit-0.7.5-py3-none-any.whl

Total release size: 319.1 kB

Release files / helmkit-0.7.5.tar.gz

Download URL helmkit-0.7.5.tar.gz
Size 179.0 kB
Tags Source
SHA-256 checksum
How to use checksums
f16bd615feeed33a3a5f71b704a532166a78ec75bf35b4fc5085b3680290fd0b
BLAKE2b-256 checksum
How to use checksums
6621e112570dcd158c176d5eb1d05cf9752bdca98d95f1eff89e52474dcf4ce8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / helmkit-0.7.5-py3-none-any.whl

Download URL helmkit-0.7.5-py3-none-any.whl
Size 140.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
44ef520e86e19d568cc4f9ecec0b3aac50a787be0096c66d47320205516c7837
BLAKE2b-256 checksum
How to use checksums
c243e48b9dba19445bdccf5dabf5e798b909bd4d0c4b566215f9f0ba535358b3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for helmkit 0.7.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page