Plugin public API reference#

This page provides links and reference pages for the public APIs of official SpectroChemPy plugins.

Workflow-oriented plugin guides remain in Plugins. For file formats and their public reader entry points, see the reader catalog.

NMR plugin#

The standalone NMR API reference provides the following entry points.

Public entry point

Purpose

spectrochempy.nmr.read

Select a reader from the input format.

spectrochempy.nmr.read_topspin

Read Bruker TopSpin data.

spectrochempy.nmr.read_agilent

Read Agilent and Varian data.

spectrochempy.nmr.read_jeol

Read JEOL JDF data.

spectrochempy.nmr.read_simpson

Read SIMPSON simulations.

spectrochempy.nmr.Experiment

Inspect and process NMR acquisitions.

PerkinElmer plugin#

spectrochempy.perkinelmer.read

Open PerkinElmer sp files.

spectrochempy.perkinelmer.read_perkinelmer

Open PerkinElmer sp files.

Carroucell plugin#

Recommended public entry point: spectrochempy.carroucell.read.

spectrochempy.carroucell.read_carroucell

Open .spa files in a directory after a carroucell experiment.

IRIS plugin#

spectrochempy.iris.IRIS

Integral inversion solver for spectroscopic data (IRIS).

Tensor plugin#

spectrochempy.tensor.CP

CP/PARAFAC decomposition of 3D datasets using TensorLy.