This is development documentation. Some features are not available in the stable release. View stable documentation.

Plugin public API reference

This page collects the generated public API pages owned by official SpectroChemPy plugins.

Workflow-oriented plugin guides remain in Plugins.

NMR plugin

spectrochempy.nmr.read	Read NMR data, auto-detecting TopSpin vs Agilent/Varian vs JEOL vs TecMag vs SIMPSON format.
spectrochempy.nmr.read_topspin	Open TopSpin Bruker NMR spectra.
spectrochempy.nmr.read_agilent	Open Agilent/Varian NMR spectra.
spectrochempy.nmr.Experiment	NMR-specific scientific interpretation of an NDDataset.

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.

Hypercomplex plugin

The recommended public API is the dataset.hyper accessor.

All hypercomplex operations are accessed through dataset.hyper:

Operation	Example
Convert to quaternion	dataset.hyper.set_quaternion(inplace=True)
Check type	dataset.hyper.is_quaternion
Extract RR component	dataset.hyper.RR
Extract RI component	dataset.hyper.component("RI")
Extract IR component	dataset.hyper.IR
Extract II component	dataset.hyper.II

For workflow-oriented explanations and examples, see Hypercomplex (quaternion) plugin.