× ⚠️ You are reading the development version documentation.
Read here the documentation of the last stable release.

Plugin-dependent Examples

SpectroChemPy keeps one central gallery, organized by scientific topic rather than by package internals. Plugin-dependent examples are maintained by the plugin that provides the feature, then staged into their natural gallery sections, such as decomposition, simulation, import/export, or NMR processing.

When an example needs a plugin, it should say so near the top of the example and use the recommended namespaced API:

import spectrochempy as scp

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

Plugin-dependent examples should use short, consistent notes such as:

Requires the spectrochempy-nmr plugin.
Install with: pip install spectrochempy[nmr]

Official plugins declare their gallery examples in an examples/gallery.toml manifest. The current list of plugin-dependent examples is generated from these manifests in Examples requiring plugins.

This convention keeps the beginner path uncluttered while still making specialized workflows easy to find.

For the list of official plugin packages and their main namespaces, see Official plugins.