Plugins and Example Data#
This page is for users who already have a working SpectroChemPy installation (see Installation Guide). Plugins add features for specific techniques or file formats; install only those you need. Use the reader catalog to check which plugin provides a given file reader.
Plugins#
Plugin |
What it adds |
|---|---|
|
NMR file readers and processing tools |
|
2D-IRIS analysis |
|
Tensor decompositions (based on TensorLy) |
|
Reader for Carroucell experiments |
|
Reader for PerkinElmer |
Install a plugin in the same environment as SpectroChemPy, with the method you used to install SpectroChemPy. Activate the environment first (for instance with the shortcut created during installation).
uv pip install spectrochempy-nmr # one plugin
uv pip install "spectrochempy[plugins]" # all plugins
mamba install -c conda-forge -c spectrocat spectrochempy-nmr # one plugin
Replace spectrochempy-nmr by the name of the plugin you need; to
install several plugins, list their names in the same command.
python -m pip install spectrochempy-nmr # one plugin
python -m pip install "spectrochempy[plugins]" # all plugins
From the plugin repository folder, with the environment active:
python -m pip install -e /path/to/plugin
The NMR plugin has a standalone repository; other source plugins remain
under plugins/.
Each plugin is versioned independently. If you use a feature whose plugin is
missing, SpectroChemPy raises a MissingPluginError that tells you which
plugin to install. See Plugins for details on each
plugin.
Example Data#
The examples and tutorials of this documentation use example data files,
which are not included in the package to keep it small. There is nothing to
install: SpectroChemPy downloads them automatically the first time they are
needed, into the testdata folder of your SpectroChemPy settings folder
(~/.spectrochempy; on Windows, %USERPROFILE%\.spectrochempy).
With conda / mamba, you can instead install them as a package, for instance to work without an internet connection:
mamba install -c conda-forge -c spectrocat spectrochempy_data
Other Optional Packages#
JupyterLab: an optional step of the installation guides, needed to run the tutorial notebooks. To add it later to an existing environment:
uv pip install jupyterlab,python -m pip install jupyterlabormamba install -c conda-forge jupyterlab.xarray: needed only to convert datasets to and from xarray objects (
uv pip install xarray,python -m pip install xarrayormamba install xarray).
If something goes wrong, see Getting Help.