Skip to main content

ionhop: ss-NMR lineshape and relaxation analysis made easy

ionhop is an open-source Python package for solid-state NMR data analysis. It merges two previously separate tools into one install:

  • ionhop.lineshape — peak deconvolution and lineshape analysis for 1D spectra (formerly published as nmrlineshapeanalyser)
  • ionhop.relaxometry — relaxation time analysis: T1, T1_rho and T2 (formerly published as relaxometrynmr)

Both modules are compatible with Bruker's NMR data; the lineshape module also accepts spectrum data saved as CSV.

Why ionhop?

Lineshape analysis (ionhop.lineshape)

  • easy and fast processing of either lineshape spectral analysis or peak deconvolution
  • works directly from processed Bruker data, e.g. data/single_peak/10/pdata/1
  • for the optimisation, you only need to input the peak position(s), it does the rest
  • freedom to fix or optimise position(s), amplitude, width, or eta (Gaussian/Lorentzian mixing) for each peak independently
  • detailed Pseudo-Voigt fit statistics saved to a txt file
  • peak deconvolution reports the percentage contribution of each peak
  • exports fit and data as CSV and the fit as a publication-quality PNG

Relaxometry (ionhop.relaxometry)

  • streamlines T1, T1_rho and T2 analysis and cuts analysis time by more than 50%
  • built-in mono-, di-, tri-, and stretched-exponential models for simple to complex relaxation behaviour
  • automatic delay-list detection (vdlist, vplist, vclist)
  • zero-filling, 0th/1st-order phase correction, Gaussian apodisation
  • trapezoid and Simpson's-rule numerical integration for peak area
  • full-spectrum and zoomed-in views for context and detail

Install

pip install ionhop

Dependencies

nmrglue
numpy >= 1.26.0
scipy
matplotlib >= 3.9.0
pandas >= 2.2.0
mrsimulator == 1.0

A Single Peak Fitting Example (ionhop.lineshape)

from ionhop.lineshape import NMRProcessor

# create NMRProcessor object
processor = NMRProcessor()

# Load filepath: always include the trailing slash
filepath = r"../data/single_peak/10/pdata/1/"

# Load the data
processor.load_data(filepath)

# Select the region of interest
x_data, y_data = processor.select_region(512, 650)

# Normalize the data and return normalised y_axis and the corresponding x_axis
x_data, y_normalized = processor.normalize_data(x_data, y_data)

# define initial parameters for the fitting
# this example is for a single peak
# format: [x0, amplitude, width, eta, offset]
# x0 (position), amplitude, width, eta (mixing parameter), offset
# x0 has to be close to the peak position
# offset is shared across all peaks and must be in the normalized 0-1 scale
initial_params = [
    581, 0.12, 40.51, 0.89, 0.0,
]

# Specify the number of peaks to be fitted
number_of_peaks = 1

# fixed_x0 controls whether peak positions should be fixed during fitting
# False means position can vary, True means position is fixed
fixed_x0 = [False] * number_of_peaks

# fixed_eta controls whether each peak's eta (Gaussian/Lorentzian mixing) is fixed
# False means eta is fitted freely (this is the default if fixed_eta is omitted)
# True fixes it at its initial_params value
fixed_eta = [False] * number_of_peaks

# Fit the data
popt, metrics, fitted = processor.fit_peaks(
    x_data, y_normalized, initial_params, fixed_x0, fixed_eta=fixed_eta
)

# popt is the optimized parameters
# metrics is the metrics of the fitting
# fitted is the fitted curve data

# Plot and examine the results of the fitting
fig, axes, components = processor.plot_results(x_data, y_normalized, fitted, popt)

# Save the figure as a png file and the results as a csv file
processor.save_results(filepath, x_data, y_normalized, fitted, metrics, popt, components)

This generates a fit image and a metrics printout like:

Peak Fitting Results:
===================

Peak 1 (Position: 582.01 ± 0.01):
Amplitude: 0.993 ± 0.002
Width: 12.33 ± 0.03 in ppm
Width: 835.74 ± 2.36 in Hz
Eta: 1.00 ± 0.01
Offset: -0.004 ± 0.000
Gaussian Area: 0.00 ± 0.10
Lorentzian Area: 19.23 ± 0.16
Total Area: 19.23 ± 0.19
--------------------------------------------------
Peak 1 Percentage is 100.00% ± 1.39%
Overall Percentage is 100.00% ± 1.39%

A Relaxometry Example (ionhop.relaxometry)

from ionhop.relaxometry import T1Functions

t1 = T1Functions()
# see the User Guide notebooks in docs/user_guide_relaxometry for full T1, T1_rho and T2 workflows

Full worked examples for both modules are in the User Guide notebooks under docs/.

Migrating from nmrlineshapeanalyser or relaxometrynmr

Both packages still install, but they now just depend on ionhop and re-export it, so existing imports keep working:

from nmrlineshapeanalyser.core import NMRProcessor   # still works
from ionhop.lineshape import NMRProcessor             # preferred

New code should target ionhop directly.

Contact

For questions and support, please open an issue in the GitHub repository.

Metadata

Release files for ionhop 0.1.0

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

Source distribution (sdist)

Source distribution for ionhop 0.1.0
File Size Uploaded Provenance Actions
ionhop-0.1.0.tar.gz 30.5 kB With provenance Details for ionhop-0.1.0.tar.gz

Built distribution (wheel)

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

Total release size: 53.3 kB

Release files / ionhop-0.1.0.tar.gz

Download URL ionhop-0.1.0.tar.gz
Size 30.5 kB
Tags Source
SHA-256 checksum
How to use checksums
5c86573a7acf363f7bd3a532005759f5ee91c363f3a2504a3daef6969d97cc18
BLAKE2b-256 checksum
How to use checksums
7785d9ad92e507a0adb9aad97be2dadf88c54a10b87da11ef1a3c056b3862109
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 31, 2026.

Transparency log

Release files / ionhop-0.1.0-py3-none-any.whl

Download URL ionhop-0.1.0-py3-none-any.whl
Size 22.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c2956ef607209a8c0a8aa880d479476e341875332712c6c16eda5fb31dccd8d6
BLAKE2b-256 checksum
How to use checksums
760be9040490a2e07ebfa0cd28bdd97cc431063b255ba29188525ee7bda1ed96
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 31, 2026.

Transparency log

Security for ionhop 0.1.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for ionhop-0.1.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 31, 2026.

Transparency log

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.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files Full provenance

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