NMR plugin

Introduction

The spectrochempy-nmr plugin provides NMR-specific readers and processing workflows, including the Bruker TopSpin reader.

Installation

Install it with:

pip install spectrochempy[nmr]

Recommended API

Use the recommended namespaced API:

import spectrochempy as scp

dataset = scp.nmr.read("path/to/fid")

The NMR plugin owns Bruker/TopSpin conventions such as experiment directory resolution, processed-data defaults, acquisition metadata, and NMR unit contexts. Core SpectroChemPy remains responsible for generic datasets, units, plotting, and ordinary FFT operations.

Compatibility aliases

Compatibility aliases:

scp.nmr.read_topspin(...) remains available as the explicit historical namespaced form.
scp.read_topspin(...) remains available as the root-level compatibility alias when the plugin is installed.

New documentation and examples should prefer the shorter scp.nmr.read(...) form.

API Reference

The generated public API page for the NMR plugin is listed in Plugin public API reference. See spectrochempy.nmr.read.

Examples

For phase-sensitive 2D NMR workflows, install hypercomplex support as well:

pip install spectrochempy[nmr,hypercomplex]

See also the hypercomplex plugin guide for phase-sensitive 2D NMR workflows built on TopSpin datasets.

Limitations

Currently, the user-facing documentation for this plugin focuses on TopSpin datasets and related NMR workflows.