Skip to main content
Change of provenance

The repository or configuration that created this release differ from a previous release. View details.

spectrochempy-nmr

NMR plugin for SpectroChemPy.

Extraction candidate: publication still belongs to the SpectroChemPy monorepo. See EXTRACTION.md for the pinned source, validation scope and remaining release/documentation handover.

This package is the home for NMR-specific readers and tools that are useful in SpectroChemPy but should not live in the core package. It currently provides a validated public 1D workflow for reading data and processing raw 1D FIDs through scp.nmr.read(...) and scp.nmr.Experiment(...). The readers also load raw 2D time-domain data and vendor-processed 2D spectra and can represent them as hypercomplex arrays; this reading/representation scope is separate from processing, which remains limited to validated 1D experiments.

Future NMR readers or processing helpers can be added here without creating a new plugin package for each vendor format. Multi-dimensional NMR processing remains under active characterization and is not currently part of the public supported processing workflow. A pseudo-2D series (a list of ordinary 1D spectra sharing a secondary coordinate, such as a relaxation series) must be distinguished from a genuine 2D experiment with two Fourier dimensions: the former follows the validated 1D processing path per spectrum.

Installation

This plugin requires SpectroChemPy 1.1.0 or later (and remains restricted to SpectroChemPy versions below 2). Users who stay on SpectroChemPy 1.0.0 should keep an earlier compatible version of this plugin.

pip install spectrochempy[nmr]

For an editable development install from this repository, see Development.

Usage

import spectrochempy as scp

dataset = scp.nmr.read("path/to/1/fid")
dataset = scp.nmr.read("path/to/1/pdata/1/1r")
dataset = scp.nmr.read("path/to/experiment", expno=1, procno=1)

experiment = scp.nmr.Experiment(dataset)
spectrum = experiment.process(apodization="em", lb=2.0, size=32768)

This explicit processing example does not imply that vendor processing parameters are automatically imported and replayed from metadata. That contract remains under active characterization.

The current explicit apodization contract covers the public modes already exposed by Experiment.process(): em(lb=...), gm(lb=..., gb=...), and sp(ssb=..., pow=...).

The result of Experiment.process() also records the SpectroChemPy-owned processing trace in result.meta.nmr_processing["scp_processing"]. requested contains only the arguments explicitly provided by the user, whereas applied contains only the operations that were actually executed and the values they really consumed. This trace is attached to the result only: the source dataset is not mutated, the vendor procs profile remains purely descriptive, and phase="metadata" does not replay TopSpin PHC0/PHC1.

The NMR ppm/frequency unit context is also provided by this plugin:

from spectrochempy_nmr.units import set_nmr_context

set_nmr_context(104.3 * scp.ur.MHz)

The compatibility aliases scp.nmr.read_topspin(...) and scp.read_topspin(...) are kept for historical usage. TopSpin is a reader, so it is not exposed as dataset.read_topspin(...) or dataset.nmr.read_topspin(...).

Development

From the plugin directory, install the plugin against an installed compatible core (or install the desired core wheel first):

python -m pip install -e ".[hypercomplex]" pytest
python -m pytest tests/ -v

Tests and examples can run outside the monorepo. Real-data tests still use scp.preferences.datadir and its sibling testdata-extra; unavailable fixtures may cause skips. A scientific baseline must record which datasets were available and must not treat skipped cases as validated.

Build source and wheel distributions from this directory:

python -m pip install build
python -m build

Both distributions include LICENSE (CeCILL-B) and NMRGLUE_LICENSE.rst (the notice for the adapted/vendorized parsers). Repository extraction does not change those parsers or introduce a dependency on nmrglue-ng.

Metadata

Release files for spectrochempy-nmr 0.2.0

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

Change of provenance

The repository or configuration that created these release files differ from that of a previous release.

We recommend inspecting the repository and configuration before proceeding. View details.

Source distribution (sdist)

Source distribution for spectrochempy-nmr 0.2.0
File Size Uploaded Provenance Actions
spectrochempy_nmr-0.2.0.tar.gz 134.0 kB With provenance Details for spectrochempy_nmr-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for spectrochempy-nmr 0.2.0
File Interpreter ABI Platform Actions
spectrochempy_nmr-0.2.0-py3-none-any.whl Python 3 none any Details for spectrochempy_nmr-0.2.0-py3-none-any.whl

Total release size: 231.7 kB

Release files / spectrochempy_nmr-0.2.0.tar.gz

Change of provenance

This file belongs to a release with changed provenance: the repository or configuration that created the release files differ from that of a previous release.

We recommend inspecting the repository and configuration before proceeding. View details.

Download URL spectrochempy_nmr-0.2.0.tar.gz
Size 134.0 kB
Tags Source
SHA-256 checksum
How to use checksums
cf19ef76ce3b2e5becc322def9067834d86070086cf836c1b854045aa5df9815
BLAKE2b-256 checksum
How to use checksums
f8bddf2c4e08b44f1326e6a977fb4f0ec2598df72fe0ec9f1bbbbe054b488d39
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Oct 26, 2026.

Transparency log

Release files / spectrochempy_nmr-0.2.0-py3-none-any.whl

Change of provenance

This file belongs to a release with changed provenance: the repository or configuration that created the release files differ from that of a previous release.

We recommend inspecting the repository and configuration before proceeding. View details.

Download URL spectrochempy_nmr-0.2.0-py3-none-any.whl
Size 97.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1f81d52527129ba3acfcf8836756a4c35eefaf2e3290feb432e629582e4003b3
BLAKE2b-256 checksum
How to use checksums
00a6aba872b06eb24ad68ae455c8032f7eac2a0b35a466b9a9db16e428961500
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 Oct 26, 2026.

Transparency log

Security for spectrochempy-nmr 0.2.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.

Change of provenance

The repository and configuration that created this release differ from a previous release.

While this could reflect a routine change by the project maintainers, it may also indicate that the release files have been compromised.

Select from 2 files

Attestation for spectrochempy_nmr-0.2.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 Oct 26, 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.

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