nmrium-core-plugins

Package containing core plugins to work with NMRium. It provides essential loaders:

• bruker
• jcamp
• jdx
• molfile
• nmre
• sdf
• smiles
• varian

And it provides the recommended post-processing plugin.

For 1D spectra:

• digitalFilter
• backwardLinearPrediction
• apodization
• zeroFilling
• fft
• phaseCorrection

For 2D spectra:

• blpDimension1
• apodizationDimension1
• zeroFillingDimension1
• fftDimension1
• nusDimension2
• apodizationDimension2
• zeroFillingDimension2
• symmetrizeCosyLike
• phaseCorrectionTwoDimensions
• fftDimension2

These features can change at any time to be sold in dedicated plugins.

Installation

$ npm i @zakodium/nmrium-core-plugins

Usage

import { FileCollection } from 'file-collection';
import init from '@zakodium/nmrium-core-plugins';

/**
 * Initialize the core with the recommended plugins
 */
const core = init();

const fileCollection = FileCollection.fromPath('path_to_data');
// we can read a zip, jdx, jdf, nmredata, json, nmrium file extensions
const result = await core.read(fileCollection, options);

// based on extension we choose the format processor
console.log(result);
// return {
//   spectra: [],
//   molecules: [],
// }

// readSource function accept a partial FileCollectionItems and a baseURL to generate a
// data structure with a source object inside with { files, filter, baseURL }

const nmriumObject = await core.readFromWebSource(
  {
    baseURL: 'https://cheminfo.github.io',
    files: [
      {
        name: 'aspirin-1h.zip',
        relativePath: 'bruker-data-test/data/zipped/aspirin-1h.zip',
      },
    ],
  },
  {},
);

This package exports all plugin classes with their instanciation method helpers. Ex: BrukerLoaderPlugin class, and brukerLoader() method.

And it exports the recommended(core, plugins) method to instance all plugins from this package and concate them with your own plugins. It returns an array of plugins, you have to register them in the core.

License

© 2025 Zakodium Sàrl. This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. CC BY-NC-SA 4.0

This package is based on MIT-licensed code that can be found here: https://doi.org/10.5281/zenodo.7100132