Skip to main content

open-source Python package for accessing and analyzing NMR data

Project description

makeshift

License: MIT Docs

An open-source Python package for accessing and analyzing NMR data from either custom input or NMR-STAR files from the BMRB.

Installation

pip install makeshift-nmr

Quickstart

import makeshift as ms

# Fetch and parse a BMRB entry into tidy chemical shifts
cs = ms.ChemicalShifts.from_bmrb(5363)
cs.data            # one row per shift: Seq_ID, Comp_ID, Atom_ID, Atom_type, Val
cs.sequences()     # one row per entity: ID, polymer type, sequence

# Re-reference shifts
cs = ms.ChemicalShifts.from_bmrb(4527, reref="lacs", calc_csi=True)
cs.reref_offsets   # {atom: offset applied}

# Build an assigned peak list (e.g. for an HSQC)
peaks = cs.peaklist()
peaks.data

Modules

Module What it does
makeshift (core) ChemicalShifts, NMRStarEntry, PeakList — fetch/parse BMRB entries, extract shifts, sequences, relaxation/order-parameter data, build peak lists.
makeshift.reref LACS and PANAV chemical-shift re-referencing (via ChemicalShifts.reref).
makeshift.spectra Read Sparky .ucsf spectra (Spectrum), pick peaks, and align peak lists (map_peaklists).
makeshift.relaxation CPMG dispersion pipeline (CPMGExperiment) and RelaxationProfile — RelaxDB-style per-residue dynamics from deposited R1/R2/NOE.
makeshift.hydronmr Predict per-residue T1/T2/NOE from a PDB structure (run).
makeshift.talosn Predict backbone torsion angles, S2 order parameters, and secondary structure from chemical shifts via the NIH TALOS-N binary (TalosN).
makeshift.utils Dependency-light helpers: dataset/structure fetching (fetch_structure), constants.

See demos/ for worked examples:

  • quick_start.ipynb (core workflow),
  • reref.ipynb (re-referencing),
  • cpmg_demo.ipynb (the CPMG pipeline),
  • bmrb_relaxation_demo.ipynb (deposited relaxation → dynamics profile)
  • talosn_demo.ipynb (TALOS-N prediction).

Re-referencing

BMRB shifts are sometimes mis-referenced — a constant offset shifts every peak of a given nucleus. ChemicalShifts.reref corrects this in place using one of two methods:

  • PANAV (Wang & Wishart 2005) — uses rarely-misreferenced HA shifts to assign secondary structure, then aligns N/CA/CB to curated per-structure reference distributions (Wang & Jardetzky 2002).
  • LACS (Wang & Markley 2009) — fits secondary shift vs. CSI so the random-coil regime intercepts at the origin; covers CA, CB, C′, N, and HN.
cs = ms.ChemicalShifts.from_bmrb(4527)
cs.reref(method="panav")   # or "lacs"
print(cs.reref_offsets)    # {'N': ..., 'CA': ..., 'CB': ..., ...}

Re-referencing example

Entry 4527 is correctly referenced; entries 6586 and 4150 have been described in the literature as needing re-referencing. The two methods have not yet been extensively compared.

Relaxation and dynamics

NMRStarEntry extracts any deposited relaxation data, and RelaxationProfile turns it into a per-residue dynamics analysis in the style of RelaxDB (Wayment-Steele, El Nesr et al.).

Pull deposited data straight from an entry:

entry = ms.NMRStarEntry.from_bmrb(25013)
entry.datasets()                 # which data types the entry holds
entry.relaxation("T2")           # R2 (also "T1"/"R1", "T1rho", "NOE") — units-aware
entry.order_parameters()         # model-free S2 (S2, Tau_e, Rex)
entry.data_loop("spectral_density_values", "_Spectral_density")  # anything else

RelaxationProfile assembles R1/R2/NOE into the R₂/R₁ observable, compares it to a HYDRONMR rigid-body prediction, and labels each residue by motional regime:

from makeshift.relaxation import RelaxationProfile

prof = RelaxationProfile.from_bmrb(25013)   # pulls T1/T2/NOE, aligns to the sequence
prof.add_rigid_prediction()                 # structure: deposited PDB → RCSB, else AlphaFold → AFDB
print(prof.label())                         # per-residue motion string
prof.plot("R2_R1")

The structure for the rigid prediction can be a local PDB, a PDB id (fetched from RCSB), or a UniProt accession (fetched from AlphaFold DB) — e.g. add_rigid_prediction("1WRP"), ("P0DP23"), or ("model.pdb"); with no argument it uses the entry's own cited PDB or AlphaFold model. makeshift does not predict structure itself.

Label tokens: A ordered, ^ µs–ms exchange (elevated R₂/R₁), v ps–ns motion (hetNOE ≤ 0.65), b both, . peak missing, t disordered terminus, p proline.

TALOS-N: prediction from chemical shifts

makeshift.talosn wraps the NIH TALOS-N binary (Shen & Bax, J. Biomol. NMR 2013), which predicts backbone φ/ψ torsion angles, per-residue S2 order parameters, and secondary structure from assigned backbone chemical shifts using a trained neural network.

The binary and its database aren't bundled — they're downloaded on demand from NIH (under their Terms of Use, which the installer prints) into a data_dir you choose. Keep that path in a variable and pass the same one to install and to each TalosN:

from pathlib import Path
from makeshift import talosn

data_dir = Path.home() / "talosn_data"
talosn.install_talosn_data(data_dir=data_dir)     # one-time, ~ a few hundred MB

tn = talosn.TalosN.from_bmrb(4527, data_dir=data_dir)
tn.run()                    # or run(auto_install=True) to fetch the binary on first use
tn.order_parameters         # predS2.tab — per-residue S2
tn.torsion_angles           # pred.tab   — φ/ψ per residue + confidence class
tn.secondary_structure      # predSS.tab — helix/sheet/coil

data_dir defaults to inside the installed package if omitted (usually not what you want for a few-hundred-MB download).

NMR-STAR concepts

NMR-STAR files are organised around saveframes, each belonging to a category (e.g. assigned_chemical_shifts, entity, sample). The three you interact with most:

  • Entry — a single BMRB deposition (one .str file).
  • Entity — a distinct molecular species (protein, DNA strand, ligand), each with its own Entity_ID.
  • Chemical shift list — the _Atom_chem_shift loop inside an assigned_chemical_shifts saveframe; one row per observed shift.

License

MIT License.

makeshift.talosn downloads and runs the TALOS-N binary, which is distributed separately by NIH under its own Terms of Use (including no redistribution without permission from the authors); those terms govern the downloaded software, not this wrapper.

Acknowledgments

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

makeshift_nmr-0.1.1.tar.gz (87.4 kB view details)

Uploaded Source

Built Distribution

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

makeshift_nmr-0.1.1-py3-none-any.whl (93.6 kB view details)

Uploaded Python 3

File details

Details for the file makeshift_nmr-0.1.1.tar.gz.

File metadata

  • Download URL: makeshift_nmr-0.1.1.tar.gz
  • Upload date:
  • Size: 87.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for makeshift_nmr-0.1.1.tar.gz
Algorithm Hash digest
SHA256 95cf8dbb1146848fe54da123bb8b3a638ab8af2a30b378f5ff66a8fba88297e7
MD5 407660bb9c96e1b120bf7d49942c4d83
BLAKE2b-256 7311241152dcb43cbdfdf02b6faa0759840b1a28d5a10450b30d84319d92cca3

See more details on using hashes here.

File details

Details for the file makeshift_nmr-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: makeshift_nmr-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 93.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for makeshift_nmr-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2b00bb8386e1aa803d651aa69c04ac05d7270bf0e15d8055f50fdbecb1ce1c46
MD5 efc1e4f682a23b87bae2d153ddf13e1e
BLAKE2b-256 70b23baa144f2c2745d00288945e94d75ecf327cb6eeccba5b792d1256274727

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